Copyright: © Copyright Agilent Technologies, 2000, 2001


About This Help File

This help file (com.hlp) is the online book that covers the Application Programming Interface to the Component Object Model that is exposed for remotely controlling 89600-series products.  This help file is a reference document for programmers to learn about the exposed objects, and their properties and methods as they develop programs for remotely controlling the 89600-series VSA software applications.

Tip

To learn how to use online help, click Help, How to Use This Help file from the menu above. To see a list of all books shipped with the analyzer, click the Roadmap button.

The left pane shows the Table of Contents for this help file. To begin, click any book in the Table of Contents, then select the desired topic.

Or, click the [image] browse button, located on the button bar at the top of this window.  Browse buttons display topics in help files in a pre-defined order, following the order that topics appear in the Table of Contents to the left.  Each click of the browse button displays the next or previous topic in the Table of Contents.


COM Overview

What is a COM API?

The Agilent Technologies 89600 VSA software provides an Application Programming Interface to its Component Object Model, or COM API.

COM is an architecture and supporting infrastructure for building, using, and evolving software "components" robustly.  The model goes beyond ordinary object oriented programming in that it describes standard ways to define and create new interfaces.  COM provides a way to create re-usable, cross-platform, language-independent applications.  The COM standard is a programming model that describes how to connect objects and construct new interfaces.

The Vector Signal Analyzer (VSA) software actually provides two separate COM APIs, called AgtVsaVector and AgtVsaScalar.  These provide software engineers with pre-built objects, methods, properties, and constants to create both Vector Signal Analyzer and Spectrum Analyzer applications.  Together, these APIs expose all of the measurement, computational, and display features of the instrument, making them accessible to C++ or Visual Basic programs.  Graphical user interface objects such as menus and dialog boxes are not exposed; nor are the security features such as licensing.

The applications are implemented as in-process automation servers in the form of ActiveX DLLs and two executable programs, VsaVector.exe and VsaScalar.exe.

Exposed objects are accessible to any application, programming tool, or language that implements automation.

The provided APIs are officially supported from the following programming environments:

•	Microsoft Visual Basic Version 5.0 or later, Enterprise and Professional editions.

•	Microsoft Visual C++ 5.0 or later in container applications that support Component Object Model automation.

The purpose of this help file is to provide enough information about the object model and the interfaces supplied with the Analyzer to permit programmers and test engineers to remotely control the instrument using the same language and methodologies they use in their other programming.  This help file provides the details necessary to automate setups and tests through ordinary Visual Basic or Visual C++ programming.

Why use COM technology?

COM objects provide programmatic access to the analyzer.

Using the COM APIs provided with the 89600 VSA software permits standardizing and automating complex instrument setups and measurements that otherwise could consume a significant amount of time for a test engineer.


API Particulars

The 89600 COM API provides a single high-level object, Application. Referencing properties of the Application object return other objects and collections.

There are five collections -- MathFuncs, Macros, Traces, DataRegs, and InpChannels. The first two are for your own use.  Any VBScript macros you develop can be added to the Macros collection, and the MathFuncs collection is likewise for accessing your own mathematical functions.  The other three collections contain only a finite number of objects. The Traces collection holds 4 Trace objects; the DataRegs collection holds 8 DataReg objects; and the InpChannels collection has the same number of InpChannel objects (1 or 2) as are configured for use with the application.

You cannot directly create any sub-objects of the Application object.  They all exist as long as the Application object exists.  The only objects that you can create indirectly are new macros and math functions.  Since most of these objects exist all the time, it is sometimes convenient to create shortcuts to objects that are frequently referenced.

Defining and Re-Using Objects

You can define a number of similar objects in advance, then shortcut to them by assigning them to object variables and calling them when needed throughout your procedure.  The following example defines oTrc1, oTrc2, oTrc3 as separate Trace objects, sets their formats, and auto scales them at various points in the procedure:

Set oApp = CreateObject("AgtVsaVector.Application")

Set oTrc1 = oApp.Display.Traces(1)

oTrc1.Format = vsaTrcFmtLogMag

Set oTrc2 = oApp.Display.Traces(2)

oTrc2.Format = vsaTrcFmtLinMag

Set oTrc3 = oApp.Display.Traces(3)

oTrc3.Format = vsaTrcFmtReal

  .

  .

  .

oTrc1.ScaleAuto

  .

  .

  .

oTrc2.ScaleAuto

  .

  .

  .

oTrc3.ScaleAuto

You can also combine object variables in an array and index into the array.

For a graphical view of the object model, refer to the topic VsaVector / VsaScalar objects.


Installing the COM API Library

The VsaVector and VsaScalar APIs consist of the executable files, and a set of online Help files (.HLP). By default, these files are installed into a directory <X:> \ Program Files \ Agilent \ 89600 VSA, where <X:> indicates the drive letter where the application was installed.  The Help files are installed into a subdirectory, help, in the same path. These elements are described in the following table:

Installation element	Files	Description
Executables	VSAVECTOR.EXE	The Analyzer's vector application.
	VSASCALAR.EXE	The Analyzer's scalar application
Help Files	COM.HLP COM.CNT	The help file you are reading, and it's Table of Contents.

The API is automatically registered with the Windows NT operating system at installation time.  When a COM automation file is registered, entries describing the object types and locations are entered into your system registry.

Before you can write a program that references the VsaScalar or VsaVector COM API objects, methods, properties, and constants, you will have to execute a few more steps from within your programming environment.  For example, if you are going to be programming in Visual Basic, you will need to add the executables to the References for your project.


Checking Errors at Run-Tme
Checking Errors at Run-Time

All COM API methods can generate an error if the method fails. Although method errors can be ignored (resulting in simpler, more readable code), it is recommended that all method errors be checked and appropriate action taken when an error is generated. Checking for errors will also aid in the development of your applications by notifying you immediately of programming errors.

The following example demonstrates one technique:

 On Error Resume Next

 Set oApp = CreateObject("AgtVsaVector.Application")

 If Err.Number <> 0 Then _

    MsgBox "Cannot CreateObject, err = " & Err.Number & ", " & Err.Description

COM API Errors

Error Number	Description
513	Unknown file format
514	No data in the file.  The format of the file may not be correct
515	The file is currently set to read-only.  Change the attribute and Save again
516	Hardware address not found
517	Hardware combination is not supported. <More Info>
518	Cannot find an input configuration.  Please reinstall product
519	Another program is using the required hardware
520	Cannot configure the hardware. <More Info>
521	Parameter out of range
522	Parameter is not the right data type
523	<Internal Error>
524	Another macro already has this name
525	The macro name is invalid. It cannot contain the characters *?|/\""<> or period.
526	Another math function already has this name
527	The math function name is invalid. It cannot contain the characters *?|/\""<> or period.
528	Parameter name not found
529	Cannot create the named event
530	Two states have the same value.  Edit the file and make all states unique
531	The frequency count marker result is not valid. <More Info>
532	Key must be an ID or name
533	Macro syntax error. <More Info>
534	Macro run time error. <More Info>
535	Macro already running. <More Info>
536	Macro stopped.
537	The trace does not contain any data.
538	Cannot create the file "<File Name>"
539	Cannot recall this file. <More Info>
540	Cannot recall this file.  The file is not the specified type.  Try another file type.
541	Cannot find a running Agilent 89600 Spectrum Analyzer.
542	Cannot save the recording. <More Info>
543	Unknown trace data
544	Setup was saved from a different application.
545	No demod information is associated with this trace.
546	No markers are on.
547	Math Error <More Info> Math '<Math Expression>', Position <Char#>
548	No hardware to calibrate.
549	Calibration failure. <More Info>
550	Calibration is in progress.
551	This file is only readable by the previous version of this application.
552	Cannot change arb source name
553	Another arb source already has this name
554	The Arb source name is invalid. It cannot contain the characters *?|/\""<> or period.
555	Invalid data for Arb source
556	Arb data bandwidth was reduced
557	Arb data was truncated to available source memory length
558	Cannot select the same ADC for both channels
559	Recursive macro invocation not allowed - macro '<Macro Name>'.
560	<Program Name> does not support the selected ADC.
561	<Internal Error>
562	<Internal Error>
563	Channel configuration not supported. <More Info>
564	<Program Name> does not support the selected converter.


Presetting to a Known State

When the applications are first installed, the DATA directories contain files called DEFAULT.SET. DEFAULT.TOL, and DEFAULT.DAP.  These files contain information needed to return the applications to the factory settings for the measurement setup state, tools (menus and toolbars), and display appearance.

When operating the instrument via the COM interface, to return the instrument to these default settings, you must call the Default methods of various objects:

Application.Default	Resets the entire application to factory default settings, including the measurement state and the display appearance.
Measurement.Default	Resets the measurement state. This includes the input, frequency, measurement, and trace settings.
Display.Default	Resets the display appearance. This includes the background colors, fonts sizes, grid arrangement, and visibility of menus.
Tip:

To ensure that you will always be able to return the instrument to factory default settings, it is recommended that you not destroy or overwrite the DEFAULT files.

See Also

Default Method


DATA Directory

The VsaVector and VsaScalar applications store needed information in directories named DATA.  For example, your math functions and macros are stored in the DATA directory.  If you allow the installation program to install the applications according to the defaults, the paths for the DATA directories will be:

      C:\Program Files\Agilent\[VsaVector | VsaScalar]\Data.


Constants Table

Enum	Constants	Value
EMsgResponse	emrConsume	0
	emrPostProcess	1
	emrPreprocess	2
VsaAnaDemAMUnit	vsaAnaDemAMUnitAM	0
	vsaAnaDemAMUnitPct	1
VsaArbSrcDataStatus	vsaArbSrcDataValid	0
	vsaArbSrcDataLimitedTime	1
	vsaArbSrcDataLimitedFreq	2
	vsaArbSrcDataNoFilter	4
	vsaArbSrcDataInvalid	32
VsaArbSrcSampModel	vsaArbSrcSampMaxFidelity	0
	vsaArbSrcSampMinMemory	1
VsaAvgStyle	vsaAvgStyleOff	0
	vsaAvgStyleRms	1
	vsaAvgStyleRmsExp	2
	vsaAvgStyleTime	3
	vsaAvgStyleTimeExp	4
	vsaAvgStylePeakHold	5
	vsaAvgStyleMinPeakHold	6
VsaButtonStyles	vsaBtnStyleDefault	0
	vsaBtnStyleTextOnly	1
	vsaBtnStyleTextAndImage	3
VsaCalGainUnit	vsaCalGainDb	0
	vsaCalGainVoltsPerVolt	1
VsaColorIndex	vsaClrTrace	0
	vsaClrMkr	1
	vsaClrSym	2
	vsaClrDataGrid	3
	vsaClrDataBack	4
	vsaClrAnnotBack	5
	vsaClrIndicator	6
	vsaClrAnnotMkr	7
	vsaClrAnnotMkrBack	8
	vsaClrSpectroMkr	9
	vsaClrTraceSelect	10
	vsaClrWCDMA8k	11
	vsaClrWCDMA16k	12
	vsaClrWCDMA32k	13
	vsaClrWCDMA64k	14
	vsaClrWCDMA128k	15
	vsaClrWCDMA256k	16
	vsaClrWCDMA512k	17
	vsaClrWCDMA1024k	18
	vsaClrWCDMA2048k	19
	vsaClrWCDMA4096k	20
	vsaClrPilot	21
	vsaClrAverage	22
	vsaClrSlotAnnot	23
	vsaClrSlotSelected	24
	vsaClrSlotPreamble	25
	vsaClrSlotPilot	26
	vsaClrSlotPilotUp	27
	vsaClrSlotPilotDown	28
	vsaClrSlotMAC	29
	vsaClrSlotData	30
VsaDigDem1xEVDataModType	vsaDigDem1xEVDataModTypeQPSK	0
	vsaDigDem1xEVDataModType8PSK	1
	vsaDigDem1xEVDataModType16QAM	2
VsaDigDem1xEVFwdTDMChanType	vsaDigDem1xEVFwdTDMChanTypePreamble	1
	vsaDigDem1xEVFwdTDMChanTypePilot	2
	vsaDigDem1xEVFwdTDMChanTypeMAC	4
	vsaDigDem1xEVFwdTDMChanTypeData	8
VsaDigDemod1xEVActiveChanDetectMode	vsaDigDemod1xEVActiveChanDetectModeAuto	0
	vsaDigDemod1xEVActiveChanDetectModePreDef	1
	vsaDigDemod1xEVActiveChanDetectModeSemi	2
VsaDigDemod1xEVDirection	vsaDigDemDir1xEVFwd	0
	vsaDigDemDir1xEVRev	1
VsaDigDemod1xEVFwdActiveChan	vsaDigDemod1xEVFwdActiveChanNone	0
	vsaDigDemod1xEVFwdActiveChanData	1
VsaDigDemod1xEVResultUnits	vsaDigDemod1xEVUnitsSlots	0
	vsaDigDemod1xEVUnitsSeconds	1
VsaDigDemod1xEVRevActiveChan	vsaDigDemod1xEVRevActiveChanNone	0
	vsaDigDemod1xEVRevActiveChanData	1
	vsaDigDemod1xEVRevActiveChanACK	2
	vsaDigDemod1xEVRevActiveChanDRC	4
	vsaDigDemod1xEVRevActiveChanPilot	8
	vsaDigDemod1xEVRevActiveChanAll	15
VsaDigDemod3GDirection	vsaDigDemDir3GPPDown	0
	vsaDigDemDir3GPPUp	1
	vsaDigDemDirCdma2000Fwd	0
	vsaDigDemDirCdma2000Rev	1
VsaDigDemod3GIQBranch	vsaDigDemod3GIQBranchI	0
	vsaDigDemod3GIQBranchQ	1
VsaDigDemod3GppScrambleCodeType	vsaDigDemod3GppScrambleCodeTypeStd	0
	vsaDigDemod3GppScrambleCodeTypeLeft	1
	vsaDigDemod3GppScrambleCodeTypeRight	2
VsaDigDemod3GppSyncType	vsaDigDemod3GppSyncTypeCPICH	0
	vsaDigDemod3GppSyncTypeSCH	1
VsaDigDemod3GResultUnits	vsaDigDemod3GUnitsSlots	0
	vsaDigDemod3GUnitsFrames	1
	vsaDigDemod3GUnitsSeconds	2
VsaDigDemod3GStandards	vsaDigDemSta3GPP	0
	vsaDigDemStaCdma2000	1
VsaDigDemodFormat	vsaDigDemFmtQAM16	0
	vsaDigDemFmtQAM32	1
	vsaDigDemFmtQAM64	2
	vsaDigDemFmtQAM256	3
	vsaDigDemFmtQPSK	4
	vsaDigDemFmtDQPSK	5
	vsaDigDemFmtPi4DQPSK	6
	vsaDigDemFmtOffsetQPSK	7
	vsaDigDemFmtBPSK	8
	vsaDigDemFmtPSK8	9
	vsaDigDemFmtMSK	10
	vsaDigDemFmtMSK2	11
	vsaDigDemFmtFSK2	12
	vsaDigDemFmtFSK4	13
	vsaDigDemFmtDVBQAM16	14
	vsaDigDemFmtDVBQAM32	15
	vsaDigDemFmtDVBQAM64	16
	vsaDigDemFmtVSB8	17
	vsaDigDemFmtVSB16	18
	vsaDigDemFmtPSKEDGE	19
	vsaDigDemFmtFSK8	20
	vsaDigDemFmtFSK16	21
	vsaDigDemFmtQAM128	22
	vsaDigDemFmtD8PSK	23
VsaDigDemodMeasFilter	vsaDigDemMeasFiltNone	0
	vsaDigDemMeasFiltRect	1
	vsaDigDemMeasFiltRootRaisedCosine	2
	vsaDigDemMeasFiltGaussian	3
	vsaDigDemMeasFiltUserDefined	4
	vsaDigDemMeasFiltLowPass	5
	vsaDigDemMeasFiltIs95BaseEq	6
	vsaDigDemMeasFiltEdge	7
VsaDigDemodRefFilter	vsaDigDemRefFiltRect	0
	vsaDigDemRefFiltRaisedCosine	1
	vsaDigDemRefFiltRootRaisedCosine	2
	vsaDigDemRefFiltGaussian	3
	vsaDigDemRefFiltUserDefined	4
	vsaDigDemRefFiltIs95Baseband	5
	vsaDigDemRefFiltEdge	6
VsaDigDemodStandards	vsaDigDemStaNADC	0
	vsaDigDemStaGSM	1
	vsaDigDemStaDECT	2
	vsaDigDemStaCDMA_BASE	3
	vsaDigDemStaCDMA_MOBILE	4
	vsaDigDemStaPDC	5
	vsaDigDemStaPHP	6
	vsaDigDemStaPHS	6
	vsaDigDemStaCDPD	7
	vsaDigDemStaTETRA	8
	vsaDigDemStaAPCO	9
	vsaDigDemStaDTV8	10
	vsaDigDemStaDTV16	11
	vsaDigDemStaDVB16	12
	vsaDigDemStaDVB32	13
	vsaDigDemStaDVB64	14
	vsaDigDemStaEDGE	15
	vsaDigDemStaBluetooth	16
	vsaDigDemSta80211b	17
	vsaDigDemStaHIPERLANLBR	18
	vsaDigDemStaHIPERLANHBR	19
	vsaDigDemStaWCDMA	20
	vsaDigDemStaVDL3	21
VsaDigDemodTDSAllocScheme	vsaDigDemTDSAllocCommon	0
	vsaDigDemTDSAllocDefault	1
	vsaDigDemTDSAllocSpecified	2
VsaDigDemodTDSNormType	vsaDigDemTDSNormIQ	0
	vsaDigDemTDSNormBeacon	1
VsaDigDemodTDSStart	vsaDigDemTDSStartSubFrame	0
	vsaDigDemTDSStart2Frame	2
VsaDigDemodTDSTimeRef	vsaDigDemTDSTimeRefDwPTS	0
	vsaDigDemTDSTimeRefUpPTS	1
	vsaDigDemTDSTimeRefTrigPoint	2
VsaDigDemodTDSTimeSlots	vsaDigDemTDSTimeSlotTS0	1
	vsaDigDemTDSTimeSlotTS1	2
	vsaDigDemTDSTimeSlotTS2	4
	vsaDigDemTDSTimeSlotTS3	8
	vsaDigDemTDSTimeSlotTS4	16
	vsaDigDemTDSTimeSlotTS5	32
	vsaDigDemTDSTimeSlotTS6	64
	vsaDigDemTDSTimeSlotDwPTS	128
	vsaDigDemTDSTimeSlotUpPTS	256
VsaDigDemSearchTimeUnit	vsaDigDemSrchTmSecond	0
	vsaDigDemSrchTmSymbol	1
VsaDSSSDataModFmt	vsaDSSSDataModFmtBarker1	0
	vsaDSSSDataModFmtBarker2	1
	vsaDSSSDataModFmtCCK5_5	2
	vsaDSSSDataModFmtCCK11	3
	vsaDSSSDataModFmtPBCC5_5	4
	vsaDSSSDataModFmtPBCC11	5
	vsaDSSSDataModFmtPBCC22	6
	vsaDSSSDataModFmtPBCC33	7
VsaDSSSDataModType	vsaDSSSDataModTypeAuto	0
	vsaDSSSDataModTypeManual	1
VsaDSSSDescrMode	vsaDSSSDescrModeOn	0
	vsaDSSSDescrModeOff	1
	vsaDSSSDescrModePreamble	2
	vsaDSSSDescrModePreambleHdr	3
VsaDSSSResultLenType	vsaDSSSResultLenTypeAuto	0
	vsaDSSSResultLenTypeManual	1
VsaDSSSStandards	vsaDSSSSta80211b	0
VsaFontIndex	vsaFntTrcAnnot	0
	vsaFntStatus	1
	vsaFntMarker	2
VsaFrqRbwCouple	vsaFrqRbwCplAuto	0
	vsaFrqRbwCplOffset	1
	vsaFrqRbwCplFixed	2
VsaFrqWindow	vsaFrqWndUniform	0
	vsaFrqWndHanning	1
	vsaFrqWndGauss	2
	vsaFrqWndFlatTop	3
VsaHwType	vsaHwTypeAdc	0
	vsaHwTypeConverter	1
	vsaHwTypeInput	2
	vsaHwTypeSource	3
VsaInpChanConnector	vsaInpChConnUnbal	0
	vsaInpChConnBal	1
VsaInpChanCouple	vsaInpChCplAC	0
	vsaInpChCplDC	1
VsaInpsChannelConfig	vsaInpsChanCnf1	0
	vsaInpsChanCnf2	1
	vsaInpsChanCnfIQ	2
VsaInpsDataFrom	vsaInpsDataFromHardware	0
	vsaInpsDataFromRecording	1
VsaLicOption	vsaLicOpt100	1
	vsaLicOptAYA	2
	vsaLicOpt105	3
	vsaLicOptB7N	5
	vsaLicOptB7R	6
VsaMeasDemodConfig	vsaMeasDemodCnfNone	0
	vsaMeasDemodCnfAnalog	1
	vsaMeasDemodCnfDigital	2
	vsaMeasDemodCnf3Gpp	3
	vsaMeasDemodCnfCdma2000	4
	vsaMeasDemodCnfOFDM	5
	vsaMeasDemodCnfDSSS	6
	vsaMeasDemodCnf1xEVDO	7
	vsaMeasDemodCnfTDSCDMA	8
VsaMkrBndPwrCalc	vsaMkrBndPwrPower	0
	vsaMkrBndPwrRms	1
	vsaMkrBndPwrRatio	2
	vsaMkrBndPwrNorm	3
VsaMkrIQBranch	vsaMkrIQBranchI	0
	vsaMkrIQBranchQ	1
VsaMkrMove	vsaMkrMovePeak	0
	vsaMkrMoveMin	1
	vsaMkrMoveLargerPeak	2
	vsaMkrMoveSmallerPeak	3
	vsaMkrMoveLeftPeak	4
	vsaMkrMoveRightPeak	5
VsaMkrPolar	vsaMkrPolarMagPhase	0
	vsaMkrPolarRealImag	1
VsaOFDMResultLenType	vsaOFDMResultLenTypeAuto	0
	vsaOFDMResultLenTypeManual	1
VsaOFDMStandards	vsaOFDMSta80211a	0
	vsaOFDMStaHIPERLAN2	1
	vsaOFDMSta80211gCCKOFDM	2
VsaOFDMSubCarrierFormat	vsaOFDMSubCarrierFmtQAM16	0
	vsaOFDMSubCarrierFmtQAM64	2
	vsaOFDMSubCarrierFmtQPSK	4
	vsaOFDMSubCarrierFmtBPSK	8
VsaOFDMSubCarrierModType	vsaOFDMSubCarrierModTypeAuto	0
	vsaOFDMSubCarrierModTypeManual	1
VsaOFDMSubCarrierSet	vsaOFDMSubCarrierSetAll	0
	vsaOFDMSubCarrierSetOneChan	1
	vsaOFDMSubCarrierSetPilots	2
VsaOFDMSyncType	vsaOFDMSyncTypeShort	0
	vsaOFDMSyncTypeChanEst	1
VsaRecLenUnit	vsaRecLenSecond	0
	vsaRecLenRecord	1
	vsaRecLenPoint	2
VsaSpcClrMap	vsaSpcClrMapColorNormal	0
	vsaSpcClrMapColorReverse	1
	vsaSpcClrMapGreyNormal	2
	vsaSpcClrMapGreyReverse	3
	vsaSpcClrMapUser	4
VsaSrcAmplUnit	vsaSrcAmplDbm	0
	vsaSrcAmplVoltRms	1
	vsaSrcAmplVolt	2
VsaSrcStyle	vsaSrcStyleOff	0
	vsaSrcStyleSine	1
	vsaSrcStyleArb	2
VsaStatusBits	vsaStatusBitNone	0
	vsaStatusBitMeasDone	1
	vsaStatusBitCalibrating	2
	vsaStatusBitAcquiring	4
	vsaStatusBitSettling	8
	vsaStatusBitWaitPreTrig	16
	vsaStatusBitWaitTrig	32
	vsaStatusBitReadingData	64
	vsaStatusBitRecording	128
	vsaStatusBitAvgComp	256
	vsaStatusBitSyncNotFound	512
	vsaStatusBitPulseNotFound	1024
	vsaStatusBitCalNeeded	4096
	vsaStatusBitCalWarmUp	8192
	vsaStatusBitExtRefLock	16384
	vsaStatusBitIntRefLock	32768
	vsaStatusBitGapData	65536
	vsaStatusBitEndData	131072
	vsaStatusBitVisible	1048576
	vsaStatusBitMeasuring	1073741824
VsaTrc3GDemChanInfo	vsaTrcDem3GChanErrInfoMin	0
	vsaTrcDem3GChanErrInfoEvmRms	0
	vsaTrcDem3GChanErrInfoEvmPk	1
	vsaTrcDem3GChanErrInfoEvmPkSym	2
	vsaTrcDem3GChanErrInfoMagErrRms	3
	vsaTrcDem3GChanErrInfoMagErrPk	4
	vsaTrcDem3GChanErrInfoMagErrPkSym	5
	vsaTrcDem3GChanErrInfoPhaseErrRms	6
	vsaTrcDem3GChanErrInfoPhaseErrPk	7
	vsaTrcDem3GChanErrInfoPhaseErrPkSym	8
	vsaTrcDem3GChanErrInfoPilotBits	9
	vsaTrcDem3GChanErrInfoSlot	10
	vsaTrcDem3GChanErrInfoTdpch	11
	vsaTrcDem3GChanErrInfoCount	12
VsaTrc3GDemCompInfo	vsaTrcDem3GCompErrInfoMin	0
	vsaTrcDem3GCompErrInfoEvmRms	0
	vsaTrcDem3GCompErrInfoEvmPk	1
	vsaTrcDem3GCompErrInfoEvmPkChip	2
	vsaTrcDem3GCompErrInfoMagErrRms	3
	vsaTrcDem3GCompErrInfoMagErrPk	4
	vsaTrcDem3GCompErrInfoMagErrPkChip	5
	vsaTrcDem3GCompErrInfoPhaseErrRms	6
	vsaTrcDem3GCompErrInfoPhaseErrPk	7
	vsaTrcDem3GCompErrInfoPhaseErrPkChip	8
	vsaTrcDem3GCompErrInfoFreqErr	9
	vsaTrcDem3GCompErrInfoIqOffset	10
	vsaTrcDem3GCompErrInfoIqGainImb	11
	vsaTrcDem3GCompErrInfoIqQuadErr	12
	vsaTrcDem3GCompErrInfoRho	13
	vsaTrcDem3GCompErrInfoActCDEPk	14
	vsaTrcDem3GCompErrInfoCDEPk	15
	vsaTrcDem3GCompErrInfoSlot	16
	vsaTrcDem3GCompErrInfoTTrig	17
	vsaTrcDem3GCompErrInfoCount	18
VsaTrcCodeOrder	vsaTrcCodeHadamard	0
	vsaTrcCodeBitRev	1
VsaTrcDataSelect	vsaTrcDataX	1
	vsaTrcDataY	2
	vsaTrcDataXY	3
VsaTrcDataStatus	vsaTrcDatStaNull	0
	vsaTrcDatStaNoData	1
	vsaTrcDatStaQuestionable	2
	vsaTrcDatStaOverload	4
	vsaTrcDatStaUnCalibrated	16
	vsaTrcDatStaNoPulse	64
	vsaTrcDatStaNoSync	128
	vsaTrcDatStaCarrierUnlocked	1024
	vsaTrcDatStaEqualized	2048
	vsaTrcDatStaRng	4096
	vsaTrcDatStaAllPts	8192
	vsaTrcDatStaMeasOffset	16384
	vsaTrcDatStaChInactive	32768
VsaTrcDemInfo	vsaTrcDemInfoEvmRms	0
	vsaTrcDemInfoMagErrRms	1
	vsaTrcDemInfoPhaseErrRms	2
	vsaTrcDemInfoFreqErr	3
	vsaTrcDemInfoAmpDroop	4
	vsaTrcDemInfoIqOffset	5
	vsaTrcDemInfoIqGainImbalance	6
	vsaTrcDemInfoQuadErr	7
	vsaTrcDemInfoEvmPeak	8
	vsaTrcDemInfoEvmPeakSym	9
	vsaTrcDemInfoMagErrPeak	10
	vsaTrcDemInfoMagErrPeakSym	11
	vsaTrcDemInfoPhaseErrPeak	12
	vsaTrcDemInfoPhaseErrPeakSym	13
	vsaTrcDemInfoClkAlign	14
	vsaTrcDemInfoMainFreqErr	15
	vsaTrcDemInfoAmpErr	16
	vsaTrcDemInfoSigToNoise	17
	vsaTrcDemInfoRho	18
	vsaTrcDemInfoEvmPeakRms	19
	vsaTrcDemInfoNinetyFivePercentEvm	20
VsaTrcFormat	vsaTrcFmtLogMag	0
	vsaTrcFmtLinMag	1
	vsaTrcFmtReal	2
	vsaTrcFmtImag	3
	vsaTrcFmtWrapPhase	4
	vsaTrcFmtUnwrapPhase	5
	vsaTrcFmtVectorIQ	6
	vsaTrcFmtVectorConst	7
	vsaTrcFmtEyeQ	8
	vsaTrcFmtEyeI	9
	vsaTrcFmtEyeTrellis	10
	vsaTrcFmtGroupDelay	11
	vsaTrcFmtLogMagLin	12
VsaTrcFreqUnit	vsaTrcFreqUnitHz	0
	vsaTrcFreqUnitCarrier	1
VsaTrcLayout	vsaTrcLytSingle	0
	vsaTrcLytStack2	1
	vsaTrcLytStack4	2
	vsaTrcLytQuad4	3
VsaTrcOFDMDemInfo	vsaTrcDemOFDMErrInfoMin	0
	vsaTrcDemOFDMErrInfoEvmRms	0
	vsaTrcDemOFDMErrInfoEvmPk	1
	vsaTrcDemOFDMErrInfoEvmPkSym	2
	vsaTrcDemOFDMErrInfoMagErrRms	3
	vsaTrcDemOFDMErrInfoMagErrPk	4
	vsaTrcDemOFDMErrInfoMagErrPkSym	5
	vsaTrcDemOFDMErrInfoPhaseErrRms	6
	vsaTrcDemOFDMErrInfoPhaseErrPk	7
	vsaTrcDemOFDMErrInfoPhaseErrPkSym	8
	vsaTrcDemOFDMErrInfoFreqErr	9
	vsaTrcDemOFDMErrInfoIqOffset	10
	vsaTrcDemOFDMErrInfoSyncCorr	11
	vsaTrcDemOFDMErrInfoLSEvm	12
	vsaTrcDemOFDMErrInfoPilotEvm	13
	vsaTrcDemOFDMErrInfoCpeRms	14
	vsaTrcDemOFDMErrInfoOctets	15
	vsaTrcDemOFDMErrInfoNSym	16
	vsaTrcDemOFDMErrInfoCodingRateNum	17
	vsaTrcDemOFDMErrInfoCodingRateDen	18
	vsaTrcDemOFDMErrInfoBitsPerSym	19
	vsaTrcDemOFDMErrInfoBitRate	20
	vsaTrcDemOFDMErrInfoCount	21
	vsaTrcDemOFDMErrInfoSymClkErr	21
	vsaTrcDemOFDMErrInfoCount2	22
VsaTrcStateShape	vsaTrcStaNone	0
	vsaTrcStaCross	1
	vsaTrcStaCircle	2
VsaTrcSymbolShape	vsaTrcSymNode	0
	vsaTrcSymNone	0
	vsaTrcSymDots	1
	vsaTrcSymBars	2
VsaTrcTblFormat	vsaTrcTblBinary	0
	vsaTrcTblHex	1
VsaTrcTimeUnit	vsaTrcTimeUnitSec	0
	vsaTrcTimeUnitSym	1
VsaTrcYUnit	vsaTrcYUnitAuto	0
	vsaTrcYUnitPeak	1
	vsaTrcYUnitRms	2
	vsaTrcYUnitPower	3
	vsaTrcYUnitMilliRms	4
VsaTrigSlope	vsaTrigSlopeNeg	0
	vsaTrigSlopePos	1
VsaTrigStyle	vsaTrigStyleAuto	0
	vsaTrigStyleLevel	1
	vsaTrigStyleMagLevel	2
	vsaTrigStyleExt	3
	vsaTrigStyleExtTTL	4


Objects Table

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Objects	Properties R = Read; RW = Read/Write	Methods	Events
AnalogDemod †	AM †	RW
	AMUnit †	RW
	FM †	RW
	FreqAuto †	RW
	PhaseAuto †	RW
	PM †	RW
Application	Build	R	Default
	Count	R	Quit
	Display	-->	RefreshCount
	ExitEnable	RW
	Item	-->
	License	-->
	Macros	-->
	MathFuncs	-->
	Measurement	-->
	MessageEnable	RW
	Title	RW
	ToolsEnable	RW
	Version	R
	Visible	RW
	WindowHandle	R
ArbSource †	Active †	RW	Remove †
	ArbStatus †	R	SaveDataReg †
	Name †	RW	SaveRecording †
ArbSources †	ActiveArbSource †	-->	NewArbSource †
	ActiveIndex †	RW	RemoveAll †
	Count †	R
	IsValidDataReg †	R
	IsValidRecording †	R
	Item †	-->
	SamplingModel †	RW
	WindowEnds †	RW
Average	Count	RW
	Fast	RW
	Repeat	RW
	Style	RW
	UpdateRate	RW
	UpdateRateIsCount	RW
Calibration	CrtnEnable	RW	Calibrate
	DcOffset	RW	ExtCalibrate †
	Delay	RW	StartCalibrate
	EqualizeChanDataReg †	RW	StartExtCalibrate †
	EqualizeChanEnable †	RW
	EqualizeChanInvert †	RW
	EqualizeFreqRelative †	R
	EqualizeRegValid †	R
	ExtConstChanEnable	RW
	ExtConverterBW	RW
	ExtConverterCF	RW
	ExtConverterIF	RW
	Gain	RW
	IfExtChanEnable	RW
	IfExtChanFile	RW
	MirrorFreq	RW
	RfExtChanEnable	RW
	RfExtChanFile	RW
	RfExtEnable	RW
	RfExtFile	RW
	UseExtConverter	RW
DataReg	IsEmpty	R	RecallFile
			Remove
DataRegs	Count	R	RemoveAll
	Item	-->
DigDemod †	ClockAdjust †	RW	EqReset †
	EqAdaptive †	RW	RecallStateDefFile †
	EqConvergence †	RW	SetSearchLen †
	EqFilterLen †	RW	SetStandard †
	Equalize †	RW	StateDefDefault †
	FilterAlpha †	RW	SyncPatternNameRemove †
	FilterRegValid †	R	SyncPatternNameRemoveAll †
	Format †	RW
	GainImbQuadSkewPPSCoupled †	RW
	MeasFilter †	RW
	MeasFilterReg †	RW
	MirrorFreq †	RW
	Normalize †	RW
	PointsPerSymbol †	RW
	PulseSearch †	RW
	RefFilter †	RW
	RefFilterReg †	RW
	ResultLen †	RW
	SearchLen †	R
	SearchLenUnit †	R
	StateDefLines †	R
	SymbolRate †	RW
	SyncOffset †	RW
	SyncPattern †	RW
	SyncPatternName †	RW
	SyncPatternNames †	R
	SyncSearch †	RW
	UserRotate †	RW
DigDemod1xEVDO †	ActiveChannelDetectionMode †	RW	SetDefault †
	CDLWalshCodeLength †	RW
	ChipRate †	RW
	CompositeCombineTDM †	RW
	Direction †	RW
	FwdActiveChannel †	RW
	FwdAnalysisChannel †	RW
	FwdDataModType †	RW
	IncludeIQOffset †	RW
	IncludePreamble †	RW
	IQBranch †	RW
	IQCombined †	RW
	LongCodeMask †	RW
	LongCodeMaskQ †	RW
	MeasInterval †	RW
	MeasOffset †	RW
	MirrorFreq †	RW
	Normalize †	RW
	PNOffset †	RW
	PreambleAutoDetect †	RW
	PreambleLength †	RW
	ResultLen †	RW
	RevActiveChannel †	RW
	WalshCodeLength †	RW
	WalshCodeNumber †	RW
DigDemod3G †	BaseCodeLength †	RW	SetDefault †
	CDLSpreadCodeLength †	RW
	CDLSymbolRate †	RW
	ChipRate †	RW
	CodeChannel †	RW
	Direction †	RW
	FilterAlpha †	RW
	IQBranch †	RW
	LongCode †	RW
	MeasInterval †	RW
	MeasOffset †	RW
	MirrorFreq †	RW
	Normalize †	RW
	ResultLen †	RW
	ScrambleCode †	RW
	ScrambleCodeOffset †	RW
	ScrambleCodeType †	RW
	SpreadCodeLength †	RW
	Standard †	RW
	SymbolRate †	RW
	SyncType †	RW
	WalshCodeLength †	RW
	WalshCodeNumber †	RW
DigDemodDSSS †	ChipRate †	RW	SetDefault †
	ClockAdjust †	RW
	DataModFormat †	RW
	DataModType †	RW
	DescrambleMode †	RW
	EqFilterLen †	RW
	Equalize †	RW
	MaxResultLen †	RW
	MeasInterval †	RW
	MeasOffset †	RW
	MirrorFreq †	RW
	Normalize †	RW
	ResultLen †	RW
	ResultLenType †	RW
	SearchLen †	RW
	TrackPhase †	RW
DigDemodOFDM †	GuardInterval †	RW	SetDefault †
	MaxResultLen †	RW
	MeasInterval †	RW
	MeasOffset †	RW
	MirrorFreq †	RW
	Normalize †	RW
	PilotTrackAmpl †	RW
	PilotTrackPhase †	RW
	PilotTrackTiming †	RW
	ResultLen †	RW
	ResultLenType †	RW
	SearchLen †	RW
	Standard †	RW
	SubCarrierModFormat †	RW
	SubCarrierModType †	RW
	SubCarrierNum †	RW
	SubCarrierSet †	RW
	SubCarrierSpacing †	RW
	SymbolTimeAdjust †	RW
	SyncType †	RW
DigDemodTDSCDMA †	ActiveSlotThreshold †	RW	SetDefault †
	AnalysisSubframes †	RW
	AnalysisTimeslots †	RW
	BasicMidambleCode †	RW
	BasicMidambleCodeGroup †	RW
	CDLSpreadCodeLength †	RW
	ChipRate †	RW
	CodeChannel †	RW
	DownlinkPilotCode †	RW
	FilterAlpha †	RW
	K †	RW
	MirrorFreq †	RW
	Normalize †	RW
	ResultLen †	RW
	ScrambleCode †	RW
	ScrambleCodeGroup †	RW
	SpreadCodeLength †	RW
	StartBoundary †	RW
	TimeReference †	RW
	UplinkPilotCode †	RW
	UplinkPilotCodeGroup †	RW
Display	Color	RW	Default
	ColorCount	R	DefaultMapUserColor
	Font	-->	MapUserColorDataSet
	IsColorByTrace	R	RecallFile
	MapUserColor	RW	RecallMapUserColorFile
	MapUserColorCount	RW	SaveFile
	MapUserColorData	R	SaveMapUserColorFile
	MapUserColorMaxCount	R
	MenuVisible	RW
	StatusVisible	RW
	Traces	-->
Frequency	Band	RW	DefaultSpan
	BandCount	R	FromSpecAnalyzer †
	BandStart	R	MirrorAroundCenter †
	BandStop	R	PointsNearest †
	Center	RW	RecordingCenterSpan †
	GateWindow †	RW	ResBWNearest
	GateWindowIsMain †	RW	SetCenterSpan
	MirrorFreq †	RW	SetStartStop
	Points	RW	SetStartStopRbw ‡
	PointsIsDisplay ‡	RW
	ResBW	RW
	ResBWArbitrary	RW
	ResBWCouple	RW
	SignalTrack	RW
	SignalTrackChannel	RW
	Span	RW
	StartFreq	RW
	Step	RW
	StepAuto	RW
	StopFreq	RW
	Window	RW
	Zoom †	RW
Hardware	Address	R	SetAddresses
	DefaultAddress	R	SetAddressesEx †
	DriverRev	R	SetAddressesMultiChan
	EnableRefLock	RW
	ExtRefFreq	RW
	ExtRefMaster	RW
	FirmwareRev	R
	Model	R
	Parameter	RW
	ParameterNames	R
	SaveAddresses	RW
	SavedAddress	R
	SelectDefault	RW
	SerialNumber	R
	Simulate	R
InpChannel	Connector	R	RangeNearest
	Couple	RW	SetConnectorImpedance
	Impedance	R
	Range	RW
	Ranges	R
	RefImpedance	RW
	RefImpedanceIsConnector	RW
InpChannels	Count	R
	Item	-->
Inputs	ChannelConfig	RW	FromSpecAnalyzer †
	DataFrom †	RW
	InpChannels	-->
	Recording †	-->
	Trigger	-->
License	Level	R
	LevelName	R
	OptionCode	R
	OptionCount	R
	OptionEnable	R
	OptionName	R
Macro	Code	RW	Remove
	Name	RW	Run
	Picture	-->	Save
MacroRun2			VsaDoEvents
			VsaInputBox
			VsaListBox
			VsaMsgBox
			VsaSleep
Macros	Count	R	CheckSyntax
	Item	-->	NewMacro
			RemoveAll
			Reset
Marker	BandPower	RW	MoveTo
	BandPowerCalc	RW
	BandPowerLeft	RW
	BandPowerResult	R
	BandPowerResultQ	R
	BandPowerResultUnit	R
	BandPowerRight	RW
	Carrier †	RW
	CarrierResult †	R
	CodeChannel	R
	Consolidate †	RW
	Couple	RW
	FreqCount	RW
	FreqCountResult	R
	IQBranch	R
	OffsetTraceTime	RW
	OffsetVisible	RW
	OffsetX	RW
	OffsetY	RW
	OffsetZ	RW
	PeakTrack	RW
	Point	RW
	PolarFormat	RW
	Slot	R
	SymbolRate	R
	TraceSelect	RW
	TraceSelectVisible	RW
	TraceTime	R
	Value	RW
	ValueUnit	R
	Visible	RW
	X	R
	Y	R
	YAverage	R
	Z	RW
	ZUnit	R
MathFunc	Name	RW	Remove
	Text	RW	Save
MathFuncs	Count	R	CheckSyntax
	Item	-->	NewMathFunc
	SyntaxErrorPos	R	RemoveAll
Measurement	AnalogDemod †	-->	Continue
	Average	-->	Default
	Calibration	-->	Disconnect
	Continuous	RW	Initialize
	DataRegs	-->	Pause
	DemodConfig †	RW	RecallFile
	DigDemod †	-->	Record †
	DigDemod1xEVDO †	-->	Reset
	DigDemod3G †	-->	SaveFile
	DigDemodDSSS †	-->	Start
	DigDemodOFDM †	-->	WaitForMeasDone
	DigDemodTDSCDMA †	-->
	Frequency	-->
	Hardware	-->
	Inputs	-->
	Source †	-->
	Status	-->
	Time †	-->
	UpdateEnable	RW
Recording †	PlayCenter †	R	RecallFile †
	PlayChannels †	R	SaveFile †
	PlayDelay †	R	SaveFileEx †
	PlayLoop †	RW	SetRecLen †
	PlayMaxSpan †	R
	PlayPoints †	R
	PlaySampleRate †	R
	PlaySpan †	R
	PlayStart †	RW
	PlayStop †	RW
	PlayZoom †	R
	Position †	RW
	RecLen †	R
	RecLenUnit †	R
	RecMaxLen †	RW
	RecSettle †	RW
	TempFile †	RW
	Trigger †	-->
Source †	Amplitude †	RW
	ArbSources †	-->
	Enable †	RW
	Frequency †	RW
	OffsetFrequency †	RW
	Step †	RW
	StepAuto †	RW
	Style †	RW
	TrackFrequency †	RW
Spectrogram	ColorCount	RW
	ColorMap	RW
	Count	R
	DataAtScan	R
	Enhance	RW
	MapColorData	R
	MaxCount	RW
	ScanAtTime	R
	Threshold	RW
	TimeAtScan	R
	Visible	RW
Status	EventName	RW		MeasErrorEvent
	MeasError	R		NegativeEvent
	NegativeEventSum	R		PositiveEvent
	NegativeMask	RW
	PositiveEventSum	R
	PositiveMask	RW
	Value	R
Time †	Gate †	RW
	GateDelayChan †	RW
	GateLen †	RW
	MainLen †	RW
	Overlap †	RW
	OverlapAverage †	RW
	Points †	RW
	ResolutionAuto †	RW
Trace	Active	RW	ApertureNearest
	Aperture	RW	CopyDataToClipboard
	Data	R	CopyToDataReg
	DataName	RW	SaveFile
	DataNameNoData	R	ScaleAuto
	DataNames	R	WaitForValidTrace
	DataNamesMath	R	YScaleAuto
	DataNamesMeas	R
	DataNamesReg	R
	DemodChipRate †	R
	DemodCodeOrder †	RW
	DemodFreqUnit †	RW
	DemodStateShape †	RW
	DemodStateSize †	RW
	DemodSymbolShape †	RW
	DemodTblFormat †	RW
	DemodTimeUnit †	RW
	Format	RW
	Marker	-->
	PhaseOffset	RW
	RawData	R
	RawData3GChanDemodInfo †	R
	RawData3GCompDemodInfo †	R
	RawDataComplex	R
	RawDataDemodInfo †	R
	RawDataInfo	R
	RawDataOFDMDemodInfo †	R
	RawDataPoints	R
	RawDataStatus	R
	RawDataValue	R
	RawDataValueNames	R
	RawDataValueUnit	R
	RawDataXDelta	R
	RawDataXStart	R
	Spectrogram	-->
	Title	R
	TriggerRefLineVisible	RW
	UnwrapRef	RW
	VectorXCenter	RW
	Visible	RW
	XAxisUnit	R
	XEyeLength †	RW
	XLeft	RW
	XLog	RW
	XRight	RW
	XScaleAuto	RW
	YAxisUnit	R
	YLogRatio	RW
	YPerDiv	RW
	YRefLevel	RW
	YRefPosition	RW
	YRefTrackRange	RW
	YRefVisible	RW
	YUnit	RW
	ZAxisUnit	R
	ZFirst	R
	ZLast	R
	ZPoints	R
Traces	ActiveIndex	RW	CopyMarkersToClipboard
	ActiveTrace	-->	ScaleAuto
	AnnotationVisible	RW
	Count	R
	GridVisible	RW
	Item	-->
	Layout	RW
	ShowAllPoints	RW
	XCenterFreq	RW
Trigger	Channel	RW
	Delay	RW
	ExtLevel	RW
	Holdoff	RW
	Level	RW
	MagLevel	RW
	Slope	RW
	Style	RW


Properties Table

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Property	Access	Applies To
Active †	RW	ArbSource, Trace
ActiveArbSource †	-->	ArbSources
ActiveChannelDetectionMode †	RW	DigDemod1xEVDO
ActiveIndex †	RW	ArbSources, Traces
ActiveSlotThreshold †	RW	DigDemodTDSCDMA
ActiveTrace	-->	Traces
Address	R	Hardware
AM †	RW	AnalogDemod
Amplitude †	RW	Source
AMUnit †	RW	AnalogDemod
AnalogDemod †	-->	Measurement
AnalysisSubframes †	RW	DigDemodTDSCDMA
AnalysisTimeslots †	RW	DigDemodTDSCDMA
AnnotationVisible	RW	Traces
Aperture	RW	Trace
ArbSources †	-->	Source
ArbStatus †	R	ArbSource
Average	-->	Measurement
Band	RW	Frequency
BandCount	R	Frequency
BandPower	RW	Marker
BandPowerCalc	RW	Marker
BandPowerLeft	RW	Marker
BandPowerResult	R	Marker
BandPowerResultQ	R	Marker
BandPowerResultUnit	R	Marker
BandPowerRight	RW	Marker
BandStart	R	Frequency
BandStop	R	Frequency
BaseCodeLength †	RW	DigDemod3G
BasicMidambleCode †	RW	DigDemodTDSCDMA
BasicMidambleCodeGroup †	RW	DigDemodTDSCDMA
Build	R	Application
Calibration	-->	Measurement
Carrier †	RW	Marker
CarrierResult †	R	Marker
CDLSpreadCodeLength †	RW	DigDemod3G, DigDemodTDSCDMA
CDLSymbolRate †	RW	DigDemod3G
CDLWalshCodeLength †	RW	DigDemod1xEVDO
Center	RW	Frequency
Channel	RW	Trigger
ChannelConfig	RW	Inputs
ChipRate †	RW	DigDemod1xEVDO, DigDemod3G, DigDemodDSSS, DigDemodTDSCDMA
ClockAdjust †	RW	DigDemod, DigDemodDSSS
Code	RW	Macro
CodeChannel †		DigDemod3G, DigDemodTDSCDMA, Marker
Color	RW	Display
ColorCount		Display, Spectrogram
ColorMap	RW	Spectrogram
CompositeCombineTDM †	RW	DigDemod1xEVDO
Connector	R	InpChannel
Consolidate †	RW	Marker
Continuous	RW	Measurement
Count		Application, ArbSources, Average, DataRegs, InpChannels, Macros, MathFuncs, Spectrogram, Traces
Couple	RW	InpChannel, Marker
CrtnEnable	RW	Calibration
Data	R	Trace
DataAtScan	R	Spectrogram
DataFrom †	RW	Inputs
DataModFormat †	RW	DigDemodDSSS
DataModType †	RW	DigDemodDSSS
DataName	RW	Trace
DataNameNoData	R	Trace
DataNames	R	Trace
DataNamesMath	R	Trace
DataNamesMeas	R	Trace
DataNamesReg	R	Trace
DataRegs	-->	Measurement
DcOffset	RW	Calibration
DefaultAddress	R	Hardware
Delay	RW	Calibration, Trigger
DemodChipRate †	R	Trace
DemodCodeOrder †	RW	Trace
DemodConfig †	RW	Measurement
DemodFreqUnit †	RW	Trace
DemodStateShape †	RW	Trace
DemodStateSize †	RW	Trace
DemodSymbolShape †	RW	Trace
DemodTblFormat †	RW	Trace
DemodTimeUnit †	RW	Trace
DescrambleMode †	RW	DigDemodDSSS
DigDemod †	-->	Measurement
DigDemod1xEVDO †	-->	Measurement
DigDemod3G †	-->	Measurement
DigDemodDSSS †	-->	Measurement
DigDemodOFDM †	-->	Measurement
DigDemodTDSCDMA †	-->	Measurement
Direction †	RW	DigDemod1xEVDO, DigDemod3G
Display	-->	Application
DownlinkPilotCode †	RW	DigDemodTDSCDMA
DriverRev	R	Hardware
Enable †	RW	Source
EnableRefLock	RW	Hardware
Enhance	RW	Spectrogram
EqAdaptive †	RW	DigDemod
EqConvergence †	RW	DigDemod
EqFilterLen †	RW	DigDemod, DigDemodDSSS
Equalize †	RW	DigDemod, DigDemodDSSS
EqualizeChanDataReg †	RW	Calibration
EqualizeChanEnable †	RW	Calibration
EqualizeChanInvert †	RW	Calibration
EqualizeFreqRelative †	R	Calibration
EqualizeRegValid †	R	Calibration
EventName	RW	Status
ExitEnable	RW	Application
ExtConstChanEnable	RW	Calibration
ExtConverterBW	RW	Calibration
ExtConverterCF	RW	Calibration
ExtConverterIF	RW	Calibration
ExtLevel	RW	Trigger
ExtRefFreq	RW	Hardware
ExtRefMaster	RW	Hardware
Fast	RW	Average
FilterAlpha †	RW	DigDemod, DigDemod3G, DigDemodTDSCDMA
FilterRegValid †	R	DigDemod
FirmwareRev	R	Hardware
FM †	RW	AnalogDemod
Font	-->	Display
Format †	RW	DigDemod, Trace
FreqAuto †	RW	AnalogDemod
FreqCount	RW	Marker
FreqCountResult	R	Marker
Frequency		Measurement, Source
FwdActiveChannel †	RW	DigDemod1xEVDO
FwdAnalysisChannel †	RW	DigDemod1xEVDO
FwdDataModType †	RW	DigDemod1xEVDO
Gain	RW	Calibration
GainImbQuadSkewPPSCoupled †	RW	DigDemod
Gate †	RW	Time
GateDelayChan †	RW	Time
GateLen †	RW	Time
GateWindow †	RW	Frequency
GateWindowIsMain †	RW	Frequency
GridVisible	RW	Traces
GuardInterval †	RW	DigDemodOFDM
Hardware	-->	Measurement
Holdoff	RW	Trigger
IfExtChanEnable	RW	Calibration
IfExtChanFile	RW	Calibration
Impedance	R	InpChannel
IncludeIQOffset †	RW	DigDemod1xEVDO
IncludePreamble †	RW	DigDemod1xEVDO
InpChannels	-->	Inputs
Inputs	-->	Measurement
IQBranch †		DigDemod1xEVDO, DigDemod3G, Marker
IQCombined †	RW	DigDemod1xEVDO
IsColorByTrace	R	Display
IsEmpty	R	DataReg
IsValidDataReg †	R	ArbSources
IsValidRecording †	R	ArbSources
Item	-->	Application, ArbSources, DataRegs, InpChannels, Macros, MathFuncs, Traces
K †	RW	DigDemodTDSCDMA
Layout	RW	Traces
Level		License, Trigger
LevelName	R	License
License	-->	Application
LongCode †	RW	DigDemod3G
LongCodeMask †	RW	DigDemod1xEVDO
LongCodeMaskQ †	RW	DigDemod1xEVDO
Macros	-->	Application
MagLevel	RW	Trigger
MainLen †	RW	Time
MapColorData	R	Spectrogram
MapUserColor	RW	Display
MapUserColorCount	RW	Display
MapUserColorData	R	Display
MapUserColorMaxCount	R	Display
Marker	-->	Trace
MathFuncs	-->	Application
MaxCount	RW	Spectrogram
MaxResultLen †	RW	DigDemodDSSS, DigDemodOFDM
MeasError	R	Status
MeasFilter †	RW	DigDemod
MeasFilterReg †	RW	DigDemod
MeasInterval †	RW	DigDemod1xEVDO, DigDemod3G, DigDemodDSSS, DigDemodOFDM
MeasOffset †	RW	DigDemod1xEVDO, DigDemod3G, DigDemodDSSS, DigDemodOFDM
Measurement	-->	Application
MenuVisible	RW	Display
MessageEnable	RW	Application
MirrorFreq	RW	Calibration, DigDemod, DigDemod1xEVDO, DigDemod3G, DigDemodDSSS, DigDemodOFDM, DigDemodTDSCDMA, Frequency
Model	R	Hardware
Name †	RW	ArbSource, Macro, MathFunc
NegativeEventSum	R	Status
NegativeMask	RW	Status
Normalize †	RW	DigDemod, DigDemod1xEVDO, DigDemod3G, DigDemodDSSS, DigDemodOFDM, DigDemodTDSCDMA
OffsetFrequency †	RW	Source
OffsetTraceTime	RW	Marker
OffsetVisible	RW	Marker
OffsetX	RW	Marker
OffsetY	RW	Marker
OffsetZ	RW	Marker
OptionCode	R	License
OptionCount	R	License
OptionEnable	R	License
OptionName	R	License
Overlap †	RW	Time
OverlapAverage †	RW	Time
Parameter	RW	Hardware
ParameterNames	R	Hardware
PeakTrack	RW	Marker
PhaseAuto †	RW	AnalogDemod
PhaseOffset	RW	Trace
Picture	-->	Macro
PilotTrackAmpl †	RW	DigDemodOFDM
PilotTrackPhase †	RW	DigDemodOFDM
PilotTrackTiming †	RW	DigDemodOFDM
PlayCenter †	R	Recording
PlayChannels †	R	Recording
PlayDelay †	R	Recording
PlayLoop †	RW	Recording
PlayMaxSpan †	R	Recording
PlayPoints †	R	Recording
PlaySampleRate †	R	Recording
PlaySpan †	R	Recording
PlayStart †	RW	Recording
PlayStop †	RW	Recording
PlayZoom †	R	Recording
PM †	RW	AnalogDemod
PNOffset †	RW	DigDemod1xEVDO
Point	RW	Marker
Points	RW	Frequency, Time
PointsIsDisplay ‡	RW	Frequency
PointsPerSymbol †	RW	DigDemod
PolarFormat	RW	Marker
Position †	RW	Recording
PositiveEventSum	R	Status
PositiveMask	RW	Status
PreambleAutoDetect †	RW	DigDemod1xEVDO
PreambleLength †	RW	DigDemod1xEVDO
PulseSearch †	RW	DigDemod
Range	RW	InpChannel
Ranges	R	InpChannel
RawData	R	Trace
RawData3GChanDemodInfo †	R	Trace
RawData3GCompDemodInfo †	R	Trace
RawDataComplex	R	Trace
RawDataDemodInfo †	R	Trace
RawDataInfo	R	Trace
RawDataOFDMDemodInfo †	R	Trace
RawDataPoints	R	Trace
RawDataStatus	R	Trace
RawDataValue	R	Trace
RawDataValueNames	R	Trace
RawDataValueUnit	R	Trace
RawDataXDelta	R	Trace
RawDataXStart	R	Trace
RecLen †	R	Recording
RecLenUnit †	R	Recording
RecMaxLen †	RW	Recording
Recording †	-->	Inputs
RecSettle †	RW	Recording
RefFilter †	RW	DigDemod
RefFilterReg †	RW	DigDemod
RefImpedance	RW	InpChannel
RefImpedanceIsConnector	RW	InpChannel
Repeat	RW	Average
ResBW	RW	Frequency
ResBWArbitrary	RW	Frequency
ResBWCouple	RW	Frequency
ResolutionAuto †	RW	Time
ResultLen †	RW	DigDemod, DigDemod1xEVDO, DigDemod3G, DigDemodDSSS, DigDemodOFDM, DigDemodTDSCDMA
ResultLenType †	RW	DigDemodDSSS, DigDemodOFDM
RevActiveChannel †	RW	DigDemod1xEVDO
RfExtChanEnable	RW	Calibration
RfExtChanFile	RW	Calibration
RfExtEnable	RW	Calibration
RfExtFile	RW	Calibration
SamplingModel †	RW	ArbSources
SaveAddresses	RW	Hardware
SavedAddress	R	Hardware
ScanAtTime	R	Spectrogram
ScrambleCode †	RW	DigDemod3G, DigDemodTDSCDMA
ScrambleCodeGroup †	RW	DigDemodTDSCDMA
ScrambleCodeOffset †	RW	DigDemod3G
ScrambleCodeType †	RW	DigDemod3G
SearchLen †		DigDemod, DigDemodDSSS, DigDemodOFDM
SearchLenUnit †	R	DigDemod
SelectDefault	RW	Hardware
SerialNumber	R	Hardware
ShowAllPoints	RW	Traces
SignalTrack	RW	Frequency
SignalTrackChannel	RW	Frequency
Simulate	R	Hardware
Slope	RW	Trigger
Slot	R	Marker
Source †	-->	Measurement
Span	RW	Frequency
Spectrogram	-->	Trace
SpreadCodeLength †	RW	DigDemod3G, DigDemodTDSCDMA
Standard †	RW	DigDemod3G, DigDemodOFDM
StartBoundary †	RW	DigDemodTDSCDMA
StartFreq	RW	Frequency
StateDefLines †	R	DigDemod
Status	-->	Measurement
StatusVisible	RW	Display
Step	RW	Frequency, Source
StepAuto	RW	Frequency, Source
StopFreq	RW	Frequency
Style	RW	Average, Source, Trigger
SubCarrierModFormat †	RW	DigDemodOFDM
SubCarrierModType †	RW	DigDemodOFDM
SubCarrierNum †	RW	DigDemodOFDM
SubCarrierSet †	RW	DigDemodOFDM
SubCarrierSpacing †	RW	DigDemodOFDM
SymbolRate †		DigDemod, DigDemod3G, Marker
SymbolTimeAdjust †	RW	DigDemodOFDM
SyncOffset †	RW	DigDemod
SyncPattern †	RW	DigDemod
SyncPatternName †	RW	DigDemod
SyncPatternNames †	R	DigDemod
SyncSearch †	RW	DigDemod
SyncType †	RW	DigDemod3G, DigDemodOFDM
SyntaxErrorPos	R	MathFuncs
TempFile †	RW	Recording
Text	RW	MathFunc
Threshold	RW	Spectrogram
Time †	-->	Measurement
TimeAtScan	R	Spectrogram
TimeReference †	RW	DigDemodTDSCDMA
Title		Application, Trace
ToolsEnable	RW	Application
Traces	-->	Display
TraceSelect	RW	Marker
TraceSelectVisible	RW	Marker
TraceTime	R	Marker
TrackFrequency †	RW	Source
TrackPhase †	RW	DigDemodDSSS
Trigger	-->	Inputs, Recording
TriggerRefLineVisible	RW	Trace
UnwrapRef	RW	Trace
UpdateEnable	RW	Measurement
UpdateRate	RW	Average
UpdateRateIsCount	RW	Average
UplinkPilotCode †	RW	DigDemodTDSCDMA
UplinkPilotCodeGroup †	RW	DigDemodTDSCDMA
UseExtConverter	RW	Calibration
UserRotate †	RW	DigDemod
Value		Marker, Status
ValueUnit	R	Marker
VectorXCenter	RW	Trace
Version	R	Application
Visible	RW	Application, Marker, Spectrogram, Trace
WalshCodeLength †	RW	DigDemod1xEVDO, DigDemod3G
WalshCodeNumber †	RW	DigDemod1xEVDO, DigDemod3G
Window	RW	Frequency
WindowEnds †	RW	ArbSources
WindowHandle	R	Application
X	R	Marker
XAxisUnit	R	Trace
XCenterFreq	RW	Traces
XEyeLength †	RW	Trace
XLeft	RW	Trace
XLog	RW	Trace
XRight	RW	Trace
XScaleAuto	RW	Trace
Y	R	Marker
YAverage	R	Marker
YAxisUnit	R	Trace
YLogRatio	RW	Trace
YPerDiv	RW	Trace
YRefLevel	RW	Trace
YRefPosition	RW	Trace
YRefTrackRange	RW	Trace
YRefVisible	RW	Trace
YUnit	RW	Trace
Z	RW	Marker
ZAxisUnit	R	Trace
ZFirst	R	Trace
ZLast	R	Trace
Zoom †	RW	Frequency
ZPoints	R	Trace
ZUnit	R	Marker


Methods Table

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Method	Applies To
ApertureNearest	Trace
Calibrate	Calibration
CheckSyntax	Macros, MathFuncs
Continue	Measurement
CopyDataToClipboard	Trace
CopyMarkersToClipboard	Traces
CopyToDataReg	Trace
Default	Application, Display, Measurement
DefaultMapUserColor	Display
DefaultSpan	Frequency
Disconnect	Measurement
EqReset †	DigDemod
ExtCalibrate †	Calibration
FromSpecAnalyzer †	Frequency, Inputs
Initialize	Measurement
MapUserColorDataSet	Display
MirrorAroundCenter †	Frequency
MoveTo	Marker
NewArbSource †	ArbSources
NewMacro	Macros
NewMathFunc	MathFuncs
Pause	Measurement
PointsNearest †	Frequency
Quit	Application
RangeNearest	InpChannel
RecallFile	DataReg, Display, Measurement, Recording
RecallMapUserColorFile	Display
RecallStateDefFile †	DigDemod
Record †	Measurement
RecordingCenterSpan †	Frequency
RefreshCount	Application
Remove †	ArbSource, DataReg, Macro, MathFunc
RemoveAll †	ArbSources, DataRegs, Macros, MathFuncs
ResBWNearest	Frequency
Reset	Macros, Measurement
Run	Macro
Save	Macro, MathFunc
SaveDataReg †	ArbSource
SaveFile	Display, Measurement, Recording, Trace
SaveFileEx †	Recording
SaveMapUserColorFile	Display
SaveRecording †	ArbSource
ScaleAuto	Trace, Traces
SetAddresses	Hardware
SetAddressesEx †	Hardware
SetAddressesMultiChan	Hardware
SetCenterSpan	Frequency
SetConnectorImpedance	InpChannel
SetDefault †	DigDemod1xEVDO, DigDemod3G, DigDemodDSSS, DigDemodOFDM, DigDemodTDSCDMA
SetRecLen †	Recording
SetSearchLen †	DigDemod
SetStandard †	DigDemod
SetStartStop	Frequency
SetStartStopRbw ‡	Frequency
Start	Measurement
StartCalibrate	Calibration
StartExtCalibrate †	Calibration
StateDefDefault †	DigDemod
SyncPatternNameRemove †	DigDemod
SyncPatternNameRemoveAll †	DigDemod
VsaDoEvents	MacroRun2
VsaInputBox	MacroRun2
VsaListBox	MacroRun2
VsaMsgBox	MacroRun2
VsaSleep	MacroRun2
WaitForMeasDone	Measurement
WaitForValidTrace	Trace
YScaleAuto	Trace


Events Table

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Event	Applies To
MeasErrorEvent	Status
NegativeEvent	Status
PositiveEvent	Status


AnalogDemod Object

(Vector only)

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
AM †	RW	Get/set if AM demod is enabled.
AMUnit †	RW	Get/set the AM demod units.
FM †	RW	Get/set if FM demod is enabled.
FreqAuto †	RW	Get/set if auto carrier frequency  is enabled.
PhaseAuto †	RW	Get/set if auto carrier phase is enabled.
PM †	RW	Get/set if PM demod is enabled.
Remarks

The AnalogDemod object provides access to the analyzer's Analog Demodulation features.  You can select independent demodulation settings for each input channel, but only one demodulation type on each channel.

The AgtVsaScalar application does not have an AnalogDemod object.

See Also

About Analog Demodulation


AM Property

(Vector only)

Get/set if AM demod is enabled.

Applies To:	AnalogDemod Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objAnalogDemod.AM(iChan)
objAnalogDemod.AM(iChan) = blnVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

Determine whether AM is the type of analog demodulation to be performed on the signal. You can select only one demodulation type (AM, FM, or PM) per input channel.

For more information, refer to Analog Demodulation Properties Overview

See Also

About Analog Demodulation

AMUnit Property


AMUnit Property

(Vector only)

Get/set the AM demod units.

Applies To:	AnalogDemod Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaAnaDemAMUnit
enumVal = objAnalogDemod.AMUnit(iChan)
objAnalogDemod.AMUnit(iChan) = enumVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

You can select the AM demodulation results to be calculated in % or AM units.  This setting is only used if you have selected AM demodulation for this channel

See Also

Units

AM Property


FM Property

(Vector only)

Get/set if FM demod is enabled.

Applies To:	AnalogDemod Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objAnalogDemod.FM(iChan)
objAnalogDemod.FM(iChan) = blnVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

Determine whether FM is the type of analog demodulation to be performed on the signal. You can select only one demodulation type (AM, FM, or PM) per input channel.

When FM is selected, you can also enable the Auto Carrier Frequency feature by setting the FreqAuto property to True. For more information, refer to About Analog Demodulation or the topic, Auto Carrier .

See Also

FM Demodulation


FreqAuto Property

(Vector only)

Get/set if auto carrier frequency  is enabled.

Applies To:	AnalogDemod Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objAnalogDemod.FreqAuto(iChan)
objAnalogDemod.FreqAuto(iChan) = blnVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

Determine whether analog demodulation Auto Carrier Frequency is enabled.

The Auto Carrier Frequency feature is applicable to FM and PM analog demodulation.

For more information, refer to the topic Auto Carrier.

See Also

Analog Demod Tab


PhaseAuto Property

(Vector only)

Get/set if auto carrier phase is enabled.

Applies To:	AnalogDemod Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objAnalogDemod.PhaseAuto(iChan)
objAnalogDemod.PhaseAuto(iChan) = blnVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

Determine whether analog demodulation Auto Carrier Phase is enabled.

The Auto Carrier Phase feature is only available for PM analog demodulation.

See also

FreqAuto Property

Auto Carrier Phase


PM Property

(Vector only)

Get/set if PM demod is enabled.

Applies To:	AnalogDemod Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objAnalogDemod.PM(iChan)
objAnalogDemod.PM(iChan) = blnVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

Determine whether PM is the type of analog demodulation to be performed on the signal.  You can select only one demodulation type (AM, FM, or PM) per input channel.

When PM is selected, you can also enable Auto Carrier Frequency (set FreqAuto to True), and Auto Carrier Phase (set PhaseAuto to True).

For more information, refer to Analog Demodulation Properties Overview. or to the topic, Auto Carrier .

See Also

PM


Application Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Build	R	Get the application build number.
Count	R	Get the count of active application instances in the Running VSA Table.
Display	-->	Get the Display object.
ExitEnable	RW	Get/set whether exitting the application from the User Interface is enabled.
Item	-->	Get the specified Application object.
License	-->	Get the License object.
Macros	-->	Get the Macros object.
MathFuncs	-->	Get the MathFuncs object.
Measurement	-->	Get the Measurement object.
MessageEnable	RW	Get/set whether showing application message dialogs should be enabled.
Title	RW	Get/set the customized  title of the main application window.
ToolsEnable	RW	Get/set whether the application User Interface is enabled.
Version	R	Get the application version.
Visible	RW	Get/set if the main application window is visible.
WindowHandle	R	Returns the Microsoft Windows handle of the main application window.
Methods	Description
Default	Set all instrument state to its default values.
Quit	Exit the application.
RefreshCount	Remove any inaccessible application instances from the Running VSA Table
Remarks

The Application object represents the entire VsaVector or VsaScalar application.  It is the "top-level object".  It provides access to application-wide properties (e.g. Title) and to the sub-objects that control the measurement, display, math functions, and macros.

You must create or get the Application object in your program.  The following sample shows three ways to create or get a reference to the VsaVector application:

Dim m_oApp As AgtVsaVector.Application

'The following two lines both create a new VsaVector application

    Set m_oApp = New AgtVsaVector.Application

    Set m_oApp = CreateObject("AgtVsaVector.Application")

    'The following line gets a reference to an existing application

    Set m_oApp = GetObject(,"AgtVsaVector.Application")

The first two examples create a new VsaVector application object, and also launch the application.  It is possible to create more than one instance of the application this way.  The third example does not launch a new application, but gets a reference to an existing VsaVector application.  If a VsaVector application is not already running, then an error is generated.

An example is shown in the introductory "Hello World" program.

Running Multiple Instances

You can run more than one instance of the VsaVector or VsaScalar application.  If more than one instance is running, use the count property to determine how many instances of a given application are running.  Use the VsaVector.item(i) or VsaScalar.item(i) property to access a specific instance.

Note

Multiple instances of the application will probably degrade speed performance, whether Visibility is turned on or not.

Tip

The Agilent\89600 VSA\Examples\vb\HelloWorlds directory contains a sample Visual BASIC program that shows you how to run and control multiple instances of the VsaVector application.

Tip

It is a good idea to call RefreshCount before looping through multiple instances of an application.

See Also

Running multiple applications with different hardware

Running multiple applications with the same hardware


Build Property

Get the application build number.

Applies To:	Application Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objApplication.Build

Remarks

The application build number is an internal Version number of the application.  Larger build numbers are newer than smaller build numbers.  The application build number is also displayed in the Help About dialog.


Count Property

Get the count of active application instances in the Running VSA Table.

Applies To:	Application Object

Access:	Read only

Syntax:	Dim intVal As Integer
intVal = objApplication.Count

Remarks

This property returns the number of applications currently running.


Display Property

Get the Display object.

Applies To:	Application Object

Syntax:	Dim objDisplay As Display
Set objDisplay = objApplication.Display

Remarks

Display (a property of the Application object) returns a Display object.

See Also

Display Object


ExitEnable Property

Get/set whether exitting the application from the User Interface is enabled.

Applies To:	Application Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objApplication.ExitEnable
objApplication.ExitEnable = blnVal

Remarks

The setting of this property determines what will happen when the user attempts to exit the application using either the File->Exit menu button, or the Windows Close button. This is significant in the case where this application was started by another via the COM API.

If ExitEnable is True (the default), then exiting this application via File->Exit or Windows Close will cause the application to shut down completely. If ExitEnable is set to false, exiting the application via File->Exit or Windows Close will simply hide the application main window, toggling the Visible property to False. The application will continue to run and be available to the entity that started it via the COM API. Setting the Visible property to True again will cause the main window to reappear.


Item Property

Get the specified Application object.

Applies To:	Application Object

Syntax:	Dim objAppl As Application
Set objAppl = objApplication.Item(Index)

Parameter	Data Type	Default Value	Description
Index	Integer	None	Gets specified item.
Remarks

Two properties help to manage every collection.  The default property, Item, returns a reference to an object in the collection.

The other property of every collection is the read-only Count property, which returns the number of objects in the collection.  The Count property can then be used to iterate through the collection.

The Item property has an index parameter, which may be a numeric index (1 is first Value) of the object in the collection.  For the ArbSources, Macros, or MathFuncs object, the index may also be a string key, which is the name of the object (see Name property)

See Also

Count Property


License Property

Get the License object.

Applies To:	Application Object

Syntax:	Dim objLicense As License
Set objLicense = objApplication.License

Remarks

License (a property of the Application object) returns a License object.

See Also

License Object


Macros Property

Get the Macros object.

Applies To:	Application Object

Syntax:	Dim objMacros As Macros
Set objMacros = objApplication.Macros

Remarks

Macros (a property of the Application object) returns a Macros object.

See Also

Macros Object


MathFuncs Property

Get the MathFuncs object.

Applies To:	Application Object

Syntax:	Dim objMathFuncs As MathFuncs
Set objMathFuncs = objApplication.MathFuncs

Remarks

MathFuncs (a property of the Application object) returns a MathFuncs object.

See Also

MathFuncs Object


Measurement Property

Get the Measurement object.

Applies To:	Application Object

Syntax:	Dim objMeasurement As Measurement
Set objMeasurement = objApplication.Measurement

Remarks

Measurement (a property of the Application object) returns a Measurement object.

See Also

Measurement Object


MessageEnable Property

Get/set whether showing application message dialogs should be enabled.

Applies To:	Application Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objApplication.MessageEnable
objApplication.MessageEnable = blnVal

Remarks

Determine whether the message dialogs generated by the application should be displayed.  If the application is being automated by another application, you may not want the application to stall as it waits for the user to press OK for a dialog message.  Setting this property to False inhibits any such dialog from being displayed.  The most common type of message dialog shown is to indicate measurement or calibration errors.  The Status.MeasError property can be read to retrieve these errors.


Title Property

Get/set the customized  title of the main application window.

Applies To:	Application Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objApplication.Title
objApplication.Title = strVal

Remarks

Sets or returns a string which is the user's Title for the running application.  The title is the text that is on the bar at the top of main application window.  If the title is an empty string, then the application will display its default title.


ToolsEnable Property

Get/set whether the application User Interface is enabled.

Applies To:	Application Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objApplication.ToolsEnable
objApplication.ToolsEnable = blnVal

Remarks


Version Property

Get the application version.

Applies To:	Application Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objApplication.Version

Remarks

The application Version string is also displayed in the Help About dialog.


Visible Property

Get/set if the main application window is visible.

Applies To:	Application Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objApplication.Visible
objApplication.Visible = blnVal

Remarks

It is useful to hide the analyzer window if you are programming and do not need to see any displayed data or do not want a user to access the analyzer's user interface.

When you create the application object programmatically, Visible is defaulted to False.  If you start the application from a user interface, Visible is defaulted to True.

For the spectrogram object, this property sets or gets whether the spectrogram is turned on (TRUE = on, FALSE = off).  The data in the spectrogram is cleared when the spectrogram is turned off.


WindowHandle Property

Returns the Microsoft Windows handle of the main application window.

Applies To:	Application Object

Access:	Read only

Syntax:	Dim lngVal As Long
lngVal = objApplication.WindowHandle

Remarks

This property returns the Microsoft Windows handle (the hWnd) of the main application window.  You can use this value in any Win32 API call to manipulate the window.  For example, you may want to call a Win32 function to raise, lower, resize, or minimize the application window.


Default Method

Set all instrument state to its default values.

Applies To:	Application Object

Syntax:	objApplication.Default

Remarks

Application object
Sets the measurement setup, display appearance, menus/toolbars, and state definitions to their default Values.  This is the same as clicking File, Preset, Preset All from the application's main menu.

Display object
Sets the display appearance to its default Values.  This is the same as clicking File, Preset, Preset Display Appearance from the application's main menu.

Measurement object
Sets the measurement setup to its default Values.  This is the same as clicking File, Preset, Preset Setup from the application's main menu.

See Also

Preset All

Preset Display Appearance

Preset Setup

Presetting to a Known State


Quit Method

Exit the application.

Applies To:	Application Object

Syntax:	objApplication.Quit

Remarks

Stops the running VsaVector or VsaScalar application.  The application stops immediately, so any unsaved data is lost.


RefreshCount Method

Remove any inaccessible application instances from the Running VSA Table

Applies To:	Application Object

Syntax:	objApplication.RefreshCount

Remarks

The 89600 software maintains an internal VsaVector table for all running VsaVector applications and a VsaScalar table for all running VsaScalar applications.  Internally, the 89600 software uses the VsaVector table to keep track of multiple instances of the VsaVector application and the VsaScalar table to keep track of multiple instances of the VsaScalar application.

You can use the count property with any VsaVector or VsaScalar object to access the VsaVector or VsaScalar table.  The count property returns the number of running applications.  If count is greater than one (there are multiple instances running), you can use the item property to access a running application.

If the 89600 software closes abnormally, the VSA table may become corrupt and contain invalid information (for example, a reference to a running VsaVector.item(i) application may return NULL).  The RefreshCount method repairs the VSA table if necessary.

Tip

It is a good idea to call RefreshCount before looping through multiple instances of an application.

See Also

Application Object

Count Property

Item Property


ArbSource Object

(Vector only)

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Active †	RW	Gets/sets whether this ArbSource is the currently active object.
ArbStatus †	R	Gets the current status of the object.
Name †	RW	Gets/sets the name of the object.
Methods	Description
Remove †	Removes this object from the ArbSources collection.
SaveDataReg †	Saves a data register as ArbSource data
SaveRecording †	Saves a recording as ArbSource data
Remarks

An ArbSource object represents a signal that was recorded by the VsaVector application and may be recreated by a signal source. The signal may be the current recording (or a portion it), or a data register containing complex time data.

To create a new ArbSource object, call the ArbSources.NewArbSource method. Set the Name property to a unique name and call either the SaveRecording or SaveDataReg method, depending on where the signal of interest is. If the save is successful, the new ArbSource is added to the ArbSources collection.

ArbSource data is stored by name in the DATA directory with the extension ARB.  It remains available any time the application is restarted, until explicitly removed.

To play back the ArbSource data through a source, set the Source object's Style property to vsaSrcStyleArb and set the ArbSources object's SamplingModel and WindowEnds properties as desired. Set the desired ArbSource Active property to True. This causes the ArbSource data to be downloaded to the source. Set the Source object Amplitude and Frequency properties as desired.


Active Property

(Vector only)

Gets/sets whether this ArbSource is the currently active object.

Applies To:	ArbSource Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objArbSource.Active
objArbSource.Active = blnVal

Remarks

Setting an ArbSource object to be active causes it to be downloaded to source hardware, if present. No download occurs if the data is already downloaded. If the Source object Style property is not set to vsaSrcStyleArb, downloading is deferred until it is.


ArbStatus Property

(Vector only)

Gets the current status of the object.

Applies To:	ArbSource Object

Access:	Read only

Syntax:	Dim enumVal As VsaArbSrcDataStatus
enumVal = objArbSource.ArbStatus

Remarks

The returned status is different from the global status word, and applies only to the ArbSource object that it is read from. ArbStatus is a composite of the following enumerated constants.

Constant	Value	Meaning
vsaArbSrcDataValid	0	ArbSource is able to be made active; if active, there is no other status condition
vsaArbSrcDataLimitedTime	1	There was insufficient memory in the hardware source; downloaded data was truncated.
vsaArbSrcDataLimitedFreq	2	The source hardware is unable to play back the ArbSource data at the recorded sample rate. It was resampled at a lower rate and some spectrum was truncated
vsaArbSrcDataNoFilter	4	The chosen sample rate is beyond the bandwidth of the widest resampling filter, so no filter is being used.†
vsaArbSrcDataInvalid	32	This is a new ArbSource object; it has not been successfully saved and can not be made active
† Some sources allow you to supply an external reconstruction filter.

A typical use of these is shown in the following snippet of code:

Dim eStatus As VsaArbSrcDataStatus

eStatus = oApp.Measurement.Source.ArbSources(1).Status

If eStatus And vsaArbSrcDataLimitedTime Then

'report low memory in the Source

End If


Name Property

(Vector only)

Gets/sets the name of the object.

Applies To:	ArbSource Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objArbSource.Name
objArbSource.Name = strVal

Remarks

The name of the object must be unique within its collection and must only contain characters that are allowed in file names. Leading and trailing spaces are stripped from the name before use. When an object is created, it is automatically initialized with a unique name.


Remove Method

(Vector only)

Removes this object from the ArbSources collection.

Applies To:	ArbSource Object

Syntax:	objArbSource.Remove

Remarks

Removes a single ArbSource object.


SaveDataReg Method

(Vector only)

Saves a data register as ArbSource data

Applies To:	ArbSource Object

Syntax:	objArbSource.SaveDataReg(DataReg)

Parameter	Data Type	Default Value	Description
DataReg	Integer	None	The data register that contains ArbSource data.
Remarks

You can only save a data register that contains zoomed, time data. To avoid raising an error, first call the ArbSources IsValidDataReg function to determine if a data register can be saved.


SaveRecording Method

(Vector only)

Saves a recording as ArbSource data

Applies To:	ArbSource Object

Syntax:	objArbSource.SaveRecording(eChanConfig)

Parameter	Data Type	Default Value	Description
eChanConfig	VsaInpsChannelConfig	None	An enumeration that specifies which channel in the recording to use for the ArbSource data (default is Channel 1).
Remarks

You can only save a single channel of zoomed data, or both channels of baseband data (in Ch1 + jCh2 mode) To avoid raising an error, first call the ArbSources IsValidRecording method to determine if a recording can be saved.


ArbSources Object

(Vector only)

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
ActiveArbSource †	-->	Returns the currently active ArbSource object.
ActiveIndex †	RW	Gets/sets the index of the currently active ArbSource.
Count †	R	Returns the number of ArbSource objects in the collection.
IsValidDataReg †	R	Indicates whether a data register can be used to create an ArbSource object.
IsValidRecording †	R	Indicates whether the current recording can be used to create an ArbSource object.
Item †	-->	Get the specified ArbSource object.
SamplingModel †	RW	Get/set the model that governs resampling when the active ArbSource data is sent to a source.
WindowEnds †	RW	Gets/sets whether the ArbSource waveform is windowed (driven to 0) at the ends when sent to a source.
Methods	Description
NewArbSource †	Returns a new uninitialized ArbSource object.
RemoveAll †	Remove all ArbSource objects from the collection.
Remarks

The ArbSources object is a collection of ArbSource objects.

The ArbSources object has methods to create new (blank) ArbSource objects, to check potential ArbSource data sources for validity, and to control the downloading behavior when an ArbSource is made active. It also has methods to manage the collection.

A read-only Count property tells how many ArbSource objects are in the collection.


ActiveArbSource Property

(Vector only)

Returns the currently active ArbSource object.

Applies To:	ArbSources Object

Syntax:	Dim objActiveArbSource As ArbSource
Set objActiveArbSource = objArbSources.ActiveArbSource

Remarks

This property is similar to the ActiveIndex property, except it returns a reference to an ArbSource object.  This property is useful to use in macros where you might want to do some operation on a user-selected ArbSource.  This is a read-only property.  Use the ArbSources.ActiveIndex or the ArbSource.Active property to set the active ArbSource.


ActiveIndex Property

(Vector only)

Gets/sets the index of the currently active ArbSource.

Applies To:	ArbSources Object

Access:	Read/Write

Syntax:	Dim intVal As Integer
intVal = objArbSources.ActiveIndex
objArbSources.ActiveIndex = intVal

Remarks

The value of this property is the index (Item number) of the active ArbSource. Writing a new value makes the indexed ArbSource active. The range is 0 to ArbSources.Count. The value 0 means no ArbSource is active.


Count Property

(Vector only)

Returns the number of ArbSource objects in the collection.

Applies To:	ArbSources Object

Access:	Read only

Syntax:	Dim intVal As Integer
intVal = objArbSources.Count

Remarks

The Count property is Read-only, and returns the number of individual items in the collection.


IsValidDataReg Property

(Vector only)

Indicates whether a data register can be used to create an ArbSource object.

Applies To:	ArbSources Object

Access:	Read only

Syntax:	Dim blnVal As Boolean
blnVal = objArbSources.IsValidDataReg(DataReg)

Parameter	Data Type	Default Value	Description
DataReg	Integer	None	An integer that selects a data register..
Remarks

This property returns True if the data in the selected data register can be used as ArbSource data.  Valid ArbSource data must be zoomed, time data.


IsValidRecording Property

(Vector only)

Indicates whether the current recording can be used to create an ArbSource object.

Applies To:	ArbSources Object

Access:	Read only

Syntax:	Dim blnVal As Boolean
blnVal = objArbSources.IsValidRecording(eChanConfig)

Parameter	Data Type	Default Value	Description
eChanConfig	VsaInpsChannelConfig	None	An enumeration that specifies which channel in the recording to use for the ArbSource data (default is Channel 1).
Remarks

This property returns True if the data in the current recording can be used as ArbSource data. The data must be a single channel of zoomed data, or two channels of baseband data (in Ch1 + jCh2 mode).  You use the eChanConfig parameter to specify the channel in the recording that you want to use as ArbSource data.


Item Property

(Vector only)

Get the specified ArbSource object.

Applies To:	ArbSources Object

Syntax:	Dim objArbSource As ArbSource
Set objArbSource = objArbSources.Item(vIndexKey)

Parameter	Data Type	Default Value	Description
vIndexKey	Variant	None	Gets specified item.
Remarks

Two properties help to manage every collection.  The default property, Item, returns a reference to an object in the collection.

The other property of every collection is the read-only Count property, which returns the number of objects in the collection.  The Count property can then be used to iterate through the collection.

The Item property has an index parameter, which may be a numeric index (1 is first Value) of the object in the collection.  For the ArbSources, Macros, or MathFuncs object, the index may also be a string key, which is the name of the object (see Name property)

See Also

Count Property

Name Property


SamplingModel Property

(Vector only)

Get/set the model that governs resampling when the active ArbSource data is sent to a source.

Applies To:	ArbSources Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaArbSrcSampModel
enumVal = objArbSources.SamplingModel
objArbSources.SamplingModel = enumVal

Remarks

This affects the way arb data is downloaded to a hardware source when any ArbSource is made active. The possible values of this property and the effects on arb data downloads are shown below. Note that only the downloaded data is affected so this property may be changed back and forth.

Constant	Effect
vsaArbSrcSampMaxFidelity	ArbSource data is resampled to a rate a bit more than twice the bandwidth of the reconstruction filter. This reproduces the signal with minimal spectral images but requires more memory in the source.
vsaArbSrcSampMinMemory	ArbSource data is not resampled. This requires the minimum memory in the source but the signal may contain spectral images that are not filtered out by the reconstruction filter
Regardless of the setting of this property, the data might be resampled if its recorded sample rate exceeds what the source may be set to.

If you change this property when the Source Style is vsaSrcStyleArb, the active ArbSource is immediately re-downloaded with the new property applied. To avoid re-downloading when you wish to change both the SamplingModel and the active ArbSource, first change the Source Style to vsaSrcStyleSine or vsaSrcStyleOff.


WindowEnds Property

(Vector only)

Gets/sets whether the ArbSource waveform is windowed (driven to 0) at the ends when sent to a source.

Applies To:	ArbSources Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objArbSources.WindowEnds
objArbSources.WindowEnds = blnVal

Remarks

Windowing the ends may be used to limit spectral splatter that would result from the discontinuity as the source wraps from the end of the arb data back to the beginning.

If this property is set to True, the beginning and end of the active ArbSource data is amplitude-modulated by a half-cycle of a raised cosine. Only a very few end points are affected. Only the downloaded data is affected, so this property may be changed back and forth.

If you change this property when the Source Style is vsaSrcStyleArb, the active ArbSource is immediately re-downloaded with the new property applied. To avoid re-downloading when you wish to change both the SamplingModel and the active ArbSource, first change the Source Style to vsaSrcStyleSine or vsaSrcStyleOff.


NewArbSource Method

(Vector only)

Returns a new uninitialized ArbSource object.

Applies To:	ArbSources Object

Syntax:	Dim objNewArbSource As ArbSource
Set objNewArbSource = objArbSources.NewArbSource

Remarks

The ArbSource that is returned from this method is not part of the ArbSources collection and cannot be made active. To make it so, you must give it a unique name and successfully call either the SaveRecording or the SaveDataReg method.


RemoveAll Method

(Vector only)

Remove all ArbSource objects from the collection.

Applies To:	ArbSources Object

Syntax:	objArbSources.RemoveAll

Remarks

The RemoveAll method removes all the ArbSource objects from the collection, and from persistent memory.


Average Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Count	RW	Get/set the number of averages.
Fast	RW	Get/set if fast averaging.
Repeat	RW	Get/set if the averaged measurement is repeated when the average is complete.
Style	RW	Get/set the average style.
UpdateRate	RW	Get/set the update rate when fast averaging.
UpdateRateIsCount	RW	Get/set if UpdateRate is the same as Count.
Remarks

The Average object provides access to the analyzer's averaging features.  You can select the averaging count, the type of averaging, and whether every average update is displayed (fast average).

See Also

About Averaging

Average Tab


Count Property

Get/set the number of averages.

Applies To:	Average Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objAverage.Count
objAverage.Count = lngVal

Remarks

Used with the Average object, the Count property sets or returns the current setting of the number of traces (1 to 99,999) to be used in calculating an average.

See Also

Count


Fast Property

Get/set if fast averaging.

Applies To:	Average Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objAverage.Fast
objAverage.Fast = blnVal

Remarks

Determine if fast averaging is enabled.  Fast averaging allows you to optimize speed of averaging measurements by not displaying every average calculated.  Use the UpdateRate property to set how often to update the trace with averaged measurement results.

For more information about fast averaging (and repeat averaging, another choice for modifying the Average), see Average Tab

See Also

Update Rate


Repeat Property

Get/set if the averaged measurement is repeated when the average is complete.

Applies To:	Average Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objAverage.Repeat
objAverage.Repeat = blnVal

Remarks

Determine whether the average measurement should be repeated or not

Set or return the setting of the averaging repeat features. Details can be found in the discussion About Averaging.

See Also

Repeat Average


Style Property

Get/set the average style.

Applies To:	Average Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaAvgStyle
enumVal = objAverage.Style
objAverage.Style = enumVal

Remarks

Determines the type of averaging to be performed by the measurement.

See Also

Averaging


UpdateRate Property

Get/set the update rate when fast averaging.

Applies To:	Average Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objAverage.UpdateRate
objAverage.UpdateRate = lngVal

Remarks

Determine the fast average update rate, which specifies how many averages to complete before updating the displayed trace.  The setting of UpdateRate only affects fast averaging.

For example, if you specify an update rate of 5, the analyzer updates the display once every 5 averages.  During fast averaging, it can be beneficial to update the display less frequently for faster operation.

For other details about averaging, see the discussion of the Average object.

See Also

Update Rate


UpdateRateIsCount Property

Get/set if UpdateRate is the same as Count.

Applies To:	Average Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objAverage.UpdateRateIsCount
objAverage.UpdateRateIsCount = blnVal

Remarks

If this is set to True, then when the average.Count value is changed, the average.UpdateRate is changed to the same value.

See Also

Same As Count


Calibration Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
CrtnEnable	RW	Get/set if corrections are applied to the measurement data.
DcOffset	RW	Get/set the DC offset added (in Volts) to the input channel.
Delay	RW	Get/set the time delay added (in Sec) to the specified input channel.
EqualizeChanDataReg †	RW	Gets/sets which data register is used for equalization for the indicated channel.
EqualizeChanEnable †	RW	Gets/sets whether equalization is enabled for the indicated channel.
EqualizeChanInvert †	RW	Gets/sets whether the contents of the equalization register are inverted prior to applying them to the correction trace.
EqualizeFreqRelative †	R	Returns true if equalizer maps frequency relatively
EqualizeRegValid †	R	Returns true if the data register can be used for equalization
ExtConstChanEnable	RW	Get/set whether user calibration constants are applied.
ExtConverterBW	RW	Get/set bandwidth of the external frequency converter.
ExtConverterCF	RW	Gets/sets the center frequency of the external frequency converter.
ExtConverterIF	RW	Gets/sets the intermediate frequency of the external frequency converter.
Gain	RW	Get/set the gain multiplier applied to the specified input channel.
IfExtChanEnable	RW	Get/set if the IfExtChanFile calibration is applied to the input data for the given channel.
IfExtChanFile	RW	Get/set the file which contains the external IF calibration for the given channel.
MirrorFreq	RW	Gets/sets the spectral order of the external downconverter.
RfExtChanEnable	RW	Get/set if the RfExtChanFile calibration is applied to the input data for the given channel.
RfExtChanFile	RW	Get/set the file which contains the external RF calibration for the given channel.
RfExtEnable	RW	Get/set if the RfExtFile calibration is applied to the input data for channel 1 (Note: this property is present for backward compatibility only. Use RfExtChanEnable for new applications).
RfExtFile	RW	Get/set the file which contains the external RF calibration for channel 1 (Note: this property is present for backward compatibility only. Use RfExtChanFile for new applications).
UseExtConverter	RW	Gets/sets whether an external down converter is being used in the system.
Methods	Description
Calibrate	Calibrate the hardware.  Returns when the calibration is finished.
ExtCalibrate †	Perform extended calibration of the hardware.  Returns when the calibration is finished.
StartCalibrate	Calibrate the hardware.  Returns immediately (before the calibration is finished).
StartExtCalibrate †	Perform extended calibration of the hardware.  Returns immediately (before the calibration is finished).
Remarks

The Calibration object represents both internal and user-defined calibration functions. When internal  calibration occurs, all amplitude ranges and all frequencies are calibrated regardless of the instrument setup. Extended calibration allows flatness and phase correction at a chosen frequency span for hardware that cannot be completely calibrated using internal calibration.

You can start a calibration and can control whether calibration data is applied to the measurement data.  In addition to the internal calibration, you can specify additional corrections to be applied to the measurement data, such as gain, delay, or frequency response. These corrections may be used to compensate for  hardware added to the measurement input. The calibration object also includes some frequency mapping properties to accommodate external tuners.

You can use the Status object to determine when a calibration is needed and to determine when the single calibration that you have started has finished.

See Also

About Calibration


CrtnEnable Property

Get/set if corrections are applied to the measurement data.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objCalibration.CrtnEnable
objCalibration.CrtnEnable = blnVal

Remarks

If CrtnEnable is set True, corrections are to be applied to measurement data based on both internally generated and user-supplied calibration data.  If CrtnEnable is set False, corrections are not applied. This will speed up the measurement, but its amplitude and phase will not be as accurate. Corrections cannot be applied to a measurement after it is completed; instead you must set CrtnEnable True and rerun the measurement.

Note: CrtnEnable does not override the UseExtConverter property.

See Also

Apply Corrections to Data


DcOffset Property

Get/set the DC offset added (in Volts) to the input channel.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objCalibration.DcOffset(iChan)
objCalibration.DcOffset(iChan) = dblVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

Determine the DC offset, in Volts, to be added mathematically to the time data from the specified input channel. No hardware setup is affected by this property. This can be used to compensate for DC offsets from external devices added to the measurement hardware. It applies only if ExtConstChanEnable is true.

See Also

External Calibration Tab


Delay Property

Get/set the time delay added (in Sec) to the specified input channel.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objCalibration.Delay(iChan)
objCalibration.Delay(iChan) = dblVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

Determines the time Delay, in seconds, to be applied mathematically to the time data from the specified input channel. No hardware setup is affected by this property. This can be used to compensate for delay from external devices added to the measurement hardware. It applies only if ExtConstChanEnable is true.

See Also

External Calibration Tab


EqualizeChanDataReg Property

(Vector only)

Gets/sets which data register is used for equalization for the indicated channel.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim intVal As Integer
intVal = objCalibration.EqualizeChanDataReg(iChan)
objCalibration.EqualizeChanDataReg(iChan) = intVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

The fixed equalizer's frequency response is defined for each channel by a data register that contains frequency-domain data. Set EqualizeChanDataReg to the index number of the data register to be used to define this response.

See Also

Fixed Equalization Tab

DataReg Object


EqualizeChanEnable Property

(Vector only)

Gets/sets whether equalization is enabled for the indicated channel.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objCalibration.EqualizeChanEnable(iChan)
objCalibration.EqualizeChanEnable(iChan) = blnVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

Set EqualizeChanEnable true to enable fixed equalization for the indicated channel. You must also properly set the EqualizeChanDataReg property.

See Also

Fixed Equalization Tab


EqualizeChanInvert Property

(Vector only)

Gets/sets whether the contents of the equalization register are inverted prior to applying them to the correction trace.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objCalibration.EqualizeChanInvert(iChan)
objCalibration.EqualizeChanInvert(iChan) = blnVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

Set EqualizeChanInvert true to invert the sense of how fixed equalization is applied to the indicated channel. If it is set to false, then the effect of equalization is to divide the incoming spectrum by the frequency response stored in the data register selected by the EqualizeChanDataReg property. If EqualizeChanInvert is set true, then the incoming spectrum is effectively multiplied by the frequency response.

See Also

Fixed Equalization Tab


EqualizeFreqRelative Property

(Vector only)

Returns true if equalizer maps frequency relatively

Applies To:	Calibration Object

Access:	Read only

Syntax:	Dim blnVal As Boolean
blnVal = objCalibration.EqualizeFreqRelative

Remarks

This read-only property tells whether relative or absolute frequency mapping is currently being used by the fixed equalizer.

The equalizer frequency response is defined for a particular channel by a data register. If the current measurement span falls within the frequency range of the data in the register, then the frequency mapping is absolute, i.e., the filter is constructed using the register's data in the same frequency range.

If some or all of the measurement span is outside of the data register's frequency range, then the data is used in a relative frequency sense: the center frequency of the data register is remapped to the measurement center frequency.

EqualizeFreqRelative will return true if the frequency mapping is relative for any channel for which the equalizer is enabled. It will return false if no active fixed equalizer is currently using relative frequency mapping.

See Also

About Fixed Equalization


EqualizeRegValid Property

(Vector only)

Returns true if the data register can be used for equalization

Applies To:	Calibration Object

Access:	Read only

Syntax:	Dim blnVal As Boolean
blnVal = objCalibration.EqualizeRegValid(iReg)

Parameter	Data Type	Default Value	Description
iReg	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

This read-only property returns true if a data register can be used to define a fixed equalizer. This requires that there is data in the register, that the domain is frequency, that there are at least 5 data points, and that the domain is not 2-dimensional.

See Also

About Fixed Equalization


ExtConstChanEnable Property

Get/set whether user calibration constants are applied.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objCalibration.ExtConstChanEnable(iChan)
objCalibration.ExtConstChanEnable(iChan) = blnVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	The hardware channel
Remarks

If set True, the DcOffset, Gain and Delay values are applied to the measurement. Otherwise, they are not. When you are measuring from a recording, these values are applied at the time that the recording was made.

See Also

DcOffset Property

Delay Property

Gain Property

Utilities->Calibration. . . ->External Amplitude tab


ExtConverterBW Property

Get/set bandwidth of the external frequency converter.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objCalibration.ExtConverterBW
objCalibration.ExtConverterBW = dblVal

Remarks

This value specifies the bandwidth of the external frequency converter. It is used to limit the maximum span in cases where the bandwidth of the external frequency converter is smaller than the bandwidth of the ADC. Applies only if UseExtConverter property is set to True.

See Also

ExtConverterCF Property

ExtConverterIF Property

UseExtConverter Property

Utilities->Calibration. . . ->External Frequency tab


ExtConverterCF Property

Gets/sets the center frequency of the external frequency converter.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objCalibration.ExtConverterCF
objCalibration.ExtConverterCF = dblVal

Remarks

This value specifies the center frequency of the external frequency converter. It is used to shift all displayed frequency values appropriately. Applies only if UseExtConverter property is set to True.

See Also

ExtConverterBW Property

ExtConverterIF Property

UseExtConverter Property

Utilities->Calibration. . . ->External Frequency tab


ExtConverterIF Property

Gets/sets the intermediate frequency of the external frequency converter.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objCalibration.ExtConverterIF
objCalibration.ExtConverterIF = dblVal

Remarks

This value specifies the IF frequency of the external frequency converter. It is used to properly set the 89600 center frequency to work with the external frequency converter. Applies only if UseExtConverter property is set to True.

See Also

ExtConverterBW Property

ExtConverterCF Property

UseExtConverter Property

Utilities->Calibration. . . ->External Frequency tab


Gain Property

Get/set the gain multiplier applied to the specified input channel.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objCalibration.Gain(iChan)
objCalibration.Gain(iChan) = dblVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

Determine the gain, specified as a voltage ratio, by which to multiply the time data from the specified input. The Value 1 represents a unity gain. This can be used to compensate for the gain of external devices added to the measurement hardware. It applies only if ExtConstChanEnable is true.

See Also

External Calibration Tab


IfExtChanEnable Property

Get/set if the IfExtChanFile calibration is applied to the input data for the given channel.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objCalibration.IfExtChanEnable(iChan)
objCalibration.IfExtChanEnable(iChan) = blnVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer that selects an input channel.
Remarks

Determine whether IF calibration data in an external file is applied to the specified input channel.  The IfExtChanFile property contains the name of the external file that contains the IF calibration data.


IfExtChanFile Property

Get/set the file which contains the external IF calibration for the given channel.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objCalibration.IfExtChanFile(iChan)
objCalibration.IfExtChanFile(iChan) = strVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer that selects an input channel.
Remarks

Determines the filename containing external IF calibration data.  Use iChan to specify the input channel for the calibration data.  The default file is UserIF.cal in the CAL directory.


MirrorFreq Property

Gets/sets the spectral order of the external downconverter.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objCalibration.MirrorFreq
objCalibration.MirrorFreq = blnVal

Remarks

If the external down converter mirrors the frequency spectrum, set this value to True so that frequency traces can be displayed properly. Applies only if UseExtConverter property is set to True

See Also

ExtConverterBW Property

ExtConverterCF Property

ExtConverterIF Property

Utilities->Calibration. . . ->External Frequency tab


RfExtChanEnable Property

Get/set if the RfExtChanFile calibration is applied to the input data for the given channel.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objCalibration.RfExtChanEnable(iChan)
objCalibration.RfExtChanEnable(iChan) = blnVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	The input channel that the calibration data is applied to.
Remarks

Determine whether RF calibration data in an external file is applied to the specified input channel.  The RfExtChanFile property contains the name of the external file that contains the RF calibration data.

See Also

RF Calibration


RfExtChanFile Property

Get/set the file which contains the external RF calibration for the given channel.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objCalibration.RfExtChanFile(iChan)
objCalibration.RfExtChanFile(iChan) = strVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	The input channel for the calibration data.
Remarks

Determines the filename containing external RF calibration data.  Use iChan to specify the input channel for the calibration data.  The default file is UserRF.cal in the CAL directory.

See Also

RfExtChanEnable Property


RfExtEnable Property

Get/set if the RfExtFile calibration is applied to the input data for channel 1 (Note: this property is present for backward compatibility only. Use RfExtChanEnable for new applications).

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objCalibration.RfExtEnable
objCalibration.RfExtEnable = blnVal

Remarks

Determine whether calibration data in an external file are applied to input data.  The RfExtFile property contains the name of the external file that contains the calibration data.

Note

This property is present for backward compatibility only.  Use RfExtChanEnable for new applications.

See Also

RfExtChanEnable Property


RfExtFile Property

Get/set the file which contains the external RF calibration for channel 1 (Note: this property is present for backward compatibility only. Use RfExtChanFile for new applications).

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objCalibration.RfExtFile
objCalibration.RfExtFile = strVal

Remarks

Determine the filename containing external RF calibration data. The default file is UserRF.cal in the CAL directory.

Note

This property is present for backward compatibility only. Use RfExtChanFile for new applications.


UseExtConverter Property

Gets/sets whether an external down converter is being used in the system.

Applies To:	Calibration Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objCalibration.UseExtConverter
objCalibration.UseExtConverter = blnVal

Remarks

Turn this value on if an external down converter is being used and you want the frequency annunciation on the displayed trace to be shifted accordingly. The property controls whether the ExtConverterBW, ExtConverterCF, and ExtConverterIF are used to shift displayed frequency values.

See Also

ExtConverterBW Property

ExtConverterCF Property

ExtConverterIF Property

Utilities->Calibration. . . ->External Frequency tab


Calibrate Method

Calibrate the hardware.  Returns when the calibration is finished.

Applies To:	Calibration Object

Syntax:	objCalibration.Calibrate

Remarks

Calibrates the measurement hardware.  The analyzer generates a separate calibration trace for each input channel.  The analyzer uses the calibration trace to correct for the gain, delay, and DC offset characteristics of an input channel.

See Also

Single Cal


ExtCalibrate Method

(Vector only)

Perform extended calibration of the hardware.  Returns when the calibration is finished.

Applies To:	Calibration Object

Syntax:	objCalibration.ExtCalibrate(sFile, dSrcPower, iChan)

Parameter	Data Type	Default Value	Description
sFile	String	None	The name of a file into which to store the calibration data
dSrcPower	Double	None	The source power setting in dBm
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

This method initiates extended calibration on the chosen channel. The source must connected properly to the analyzer before calling this method. If the method succeeds, calibration data will be written into the file named in sFile, and external IF calibration will be enabled for the chosen channel, using that file. If the method fails, the file and the state of external IF calibration is unchanged. The method does not return control until finished (or it fails).

See Also

About Extended Calibration

Setting up Hardware for Extended Calibration


StartCalibrate Method

Calibrate the hardware.  Returns immediately (before the calibration is finished).

Applies To:	Calibration Object

Syntax:	objCalibration.StartCalibrate

Remarks

This method initiates extended calibration on the chosen channel. The source must connected properly to the analyzer before calling this method. If the method succeeds, calibration data will be written into the file named in sFile, and external IF calibration will be enabled for the chosen channel, using that file. If the method fails, the file and the state of external IF calibration is unchanged. The method returns immediately. The VsaStatusBitCalibrating bit in the Status.Value property is cleared when the extended calibration is finished.  No other measurements or setups should be performed while extended calibration is in progress.

See Also

About Extended Calibration

Setting up Hardware for Extended Calibration

ExtCalibrate Method

Status Object


StartExtCalibrate Method

(Vector only)

Perform extended calibration of the hardware.  Returns immediately (before the calibration is finished).

Applies To:	Calibration Object

Syntax:	objCalibration.StartExtCalibrate(sFile, dSrcPower, iChan)

Parameter	Data Type	Default Value	Description
sFile	String	None	The name of a file into which to store the calibration data
dSrcPower	Double	None	The source power setting in dBm
iChan	Integer	None	An integer, starting at 1, that specifies the input channel
Remarks

This method initiates extended calibration on the chosen channel. The source must connected properly to the analyzer before calling this method. If the method succeeds, calibration data will be written into the file named in sFile, and external IF calibration will be enabled for the chosen channel, using that file. If the method fails, the file and the state of external IF calibration is unchanged. The method returns immediately. The VsaStatusBitCalibrating bit in the Status.Value property is cleared when the extended calibration is finished.  No other measurements or setups should be performed while extended calibration is in progress.

See Also

About Extended Calibration

Setting up Hardware for Extended Calibration

ExtCalibrate Method

Status Object


DataReg Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
IsEmpty	R	Get whether the data register contains any data.
Methods	Description
RecallFile	Recall the specified file into the data register.
Remove	Remove the contents of the data register.
Remarks

The DataReg object represents one of the data registers in the DataRegs collection.

There are eight data registers, D1 through D8.  Each one holds a complete trace copied from a trace or recalled from a file.  You can also determine whether a data register contains any data, and remove the register contents from memory.

The Trace.CopyToDataReg method copies trace data to a data register.  The Trace.SaveFile method saves data to a file in text format, MATLAB format, or SDF format (binary).  The DataReg.RecallFile method recalls a file into a data register.

A data register is selected for display on a trace by using the Trace.DataName property.  The list of available data names for data registers is returned by the Trace.DataNamesReg property.  The Trace.DataName for a data register is the data register number prefaced with "D ".

See Also

Recalling a Trace into a Data Register

Using Data Registers


IsEmpty Property

Get whether the data register contains any data.

Applies To:	DataReg Object

Access:	Read only

Syntax:	Dim blnVal As Boolean
blnVal = objDataReg.IsEmpty

Remarks

Returns whether the data register contains any data.  The RecallFile and the Trace.CopyToDataReg methods are used to load data into data registers.  The Remove and DataRegs.RemoveAll methods are used to erase data registers.

See Also

RecallFile Method

CopyToDataReg Method

Remove Method

RemoveAll Method


RecallFile Method

Recall the specified file into the data register.

Applies To:	DataReg Object

Syntax:	objDataReg.RecallFile(sFileName, sFmt)

Parameter	Data Type	Default Value	Description
sFileName	String	None	The name of the file to recall.
sFmt	String	None	The file format.
Remarks

Recalls the trace data into a data register from the specified file. The format may be one of the following:

•	CSV - Comma Separated Variables

•	MAT - MATLAB or older MATLAB Version 4.

•	SDF, DAT, TIM - 89400 file format.

•	TXT - Tab separated Variables.

If the format is an empty string, then the analyzer automatically determines the file format by looking at the file suffix.  If this is not sufficient, then the file is scanned to determine the format.

If the format cannot be determined or you specified an unknown format, then an error is raised.


Remove Method

Remove the contents of the data register.

Applies To:	DataReg Object

Syntax:	objDataReg.Remove

Remarks

Removes the contents of the specified data register.  While a data register may be loaded from a file, the remove method has no effect on the file; it just removes the data register contents from memory.

See Also

Using Data Registers

RemoveAll Method


DataRegs Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Count	R	Get the number of DataReg objects.
Item	-->	Get the specified DataReg object.
Methods	Description
RemoveAll	Remove the contents of all data registers.
Remarks

The DataRegs object contains a collection of eight DataReg objects (numbered 1 through 8), which represent the eight data registers, D1 through D8.  Each data register can hold a complete trace saved from the current measurement or recalled from a file.

As with other collections, a read-only Count property reports the number of data registers in the collection (always 8), and the default Item property returns an individual DataReg object in the collection.


Count Property

Get the number of DataReg objects.

Applies To:	DataRegs Object

Access:	Read only

Syntax:	Dim intVal As Integer
intVal = objDataRegs.Count

Remarks

The Count property is Read-only, and returns the number of individual items in the collection.

See Also

Count


Item Property

Get the specified DataReg object.

Applies To:	DataRegs Object

Syntax:	Dim objDataReg As DataReg
Set objDataReg = objDataRegs.Item(Index)

Parameter	Data Type	Default Value	Description
Index	Integer	None	Gets specified item.
Remarks

Two properties help to manage every collection.  The default property, Item, returns a reference to an object in the collection.

The other property of every collection is the read-only Count property, which returns the number of objects in the collection.  The Count property can then be used to iterate through the collection.

The Item property has an index parameter, which may be a numeric index (1 is first Value) of the object in the collection.  For the ArbSources, Macros, or MathFuncs object, the index may also be a string key, which is the name of the object (see Name property)

See Also

Count Property


RemoveAll Method

Remove the contents of all data registers.

Applies To:	DataRegs Object

Syntax:	objDataRegs.RemoveAll

Remarks

The RemoveAll method removes the contents of all the data registers. While data registers may be loaded from files, the remove method has no effect on the files, it just removes the data register contents from memory.


DigDemod Object

(Vector only)

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
ClockAdjust †	RW	Get/set the clock adjustment (in Sym).
EqAdaptive †	RW	Get/set if the equalizer is running.
EqConvergence †	RW	Get/set the equalizer convergence.
EqFilterLen †	RW	Get/set the equalizer filter length (in Sym).
Equalize †	RW	Get/set if equalizer is enabled.
FilterAlpha †	RW	Get/set the filter alpha.
FilterRegValid †	R	Gets wheither the data register is a valid measurement or reference filter.
Format †	RW	Get/set the demod format.
GainImbQuadSkewPPSCoupled †	RW	Get/Set if points per symbol coupling is enabled for gain imbalance and quadrature skew measurements.
MeasFilter †	RW	Get/set the demod measurement filter.
MeasFilterReg †	RW	Get/set the demod measurement filter data register (if MeasFilter is from a data register).
MirrorFreq †	RW	Get/set if demod will mirror the frequency spectrum.
Normalize †	RW	Get/set if demod will normalize the magnitude of the IQ data to the ideal state positions.
PointsPerSymbol †	RW	Get/set the points per symbol generated in the demod measurement data.
PulseSearch †	RW	Get/set if pulse search is enabled.
RefFilter †	RW	Get/set the demod reference filter.
RefFilterReg †	RW	Get/set the demod reference filter data register (if RefFilter is from a data register).
ResultLen †	RW	Get/set the demod measurement result length (in Sym).
SearchLen †	R	Get the search length.
SearchLenUnit †	R	Get the search length unit.
StateDefLines †	R	Get the text description of the current state definitions.
SymbolRate †	RW	Get/set the demod symbol rate.
SyncOffset †	RW	Get/set the sync search offset (in Sym).
SyncPattern †	RW	Get/Set the sync search binary pattern.
SyncPatternName †	RW	Get/set the binary pattern for the specified sync search pattern name.
SyncPatternNames †	R	Get the list of sync search pattern names.
SyncSearch †	RW	Get/set if sync search is enabled.
UserRotate †	RW	Get/set the demod user rotation value (in degrees).
Methods	Description
EqReset †	Reset the equalizer filter state.
RecallStateDefFile †	Recall the current demod state definitions from a file.
SetSearchLen †	Set the search length and unit.
SetStandard †	Set the demod properties based upon the specified demod standard.
StateDefDefault †	Set the current demod state definitions to the default values.
SyncPatternNameRemove †	Remove the specified sync search pattern name.
SyncPatternNameRemoveAll †	Remove all sync search pattern names.
Remarks

The DigDemod object provides access to the analyzer's digital demodulation measurement features.  The digital demodulation display features are controlled through the Trace object.  These features are only available if option AYA (Digital Demodulation) is installed.  For analysis of W-CDMA (3GPP) or cdma2000 signals, use the DigDemod3G object instead.

If you are unfamiliar with digital demodulation, a good starting point is the topic Setting up a Digital Demodulation Measurement.

The AgtVsaScalar application does not have a DigDemod object.

See Also

•	About Digital Demodulation Dialog Box

•	Selecting Digital Demodulation


ClockAdjust Property

(Vector only)

Get/set the clock adjustment (in Sym).

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim sngVal As Single
sngVal = objDigDemod.ClockAdjust
objDigDemod.ClockAdjust = sngVal

Remarks

The ClockAdjust property determines when the analyzer's digital demodulator samples the I/Q trajectory.

Minimum Value:	 -0.5 symbols
Maximum Value:	+0.5 symbols

The digital demodulator used in this analyzer does not require symbol-clock timing signals to determine the location of symbols (detection decision points). Instead, the digital demodulator uses an algorithm to determine symbol locations.

Some digital communications systems contain non-linearities that can bias the digital demodulator's estimation of the symbol clock position. You can use ClockAdjust to compensate for this "offset" and obtain a lower EVM (Error Vector Magnitude).

See Also

Clock Adjust


EqAdaptive Property

(Vector only)

Get/set if the equalizer is running.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod.EqAdaptive
objDigDemod.EqAdaptive = blnVal

Remarks

Determine whether the adaptive equalizer of the digital demodulation is currently running.  To use the adaptive equalizer, it must be turned on (Equalize property set to True) and it must be set to run (EqAdaptive set to True).  You can set the equalizer to stop adapting and hold its current filter by setting EqAdaptive False.  You can equalize to start over from its initial state by calling the EqReset method.

For more information, see About Adaptive Equalization

See Also

Using the Equalization Filter

EqConvergence Property

EqFilterLen Property

EqReset Method

Equalize Property


EqConvergence Property

(Vector only)

Get/set the equalizer convergence.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemod.EqConvergence
objDigDemod.EqConvergence = dblVal

Remarks

Nominal Value: 1e-07Step size: 1-2-5 sequence

Determine the convergence of the adaptive equalizer of the digital demodulation measurement.  The Value regulates the rate at which the equalization filter converges.

Stated a little differently, convergence determines how quickly the equalization filter coefficients converge to the estimated Values for each measurement.  Larger Values converge faster.

This property is only useful if the adaptive equalizer is on (Equalize property).

For more information, see Convergence (equalization).


EqFilterLen Property

(Vector only)

Get/set the equalizer filter length (in Sym).

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim intVal As Integer
intVal = objDigDemod.EqFilterLen
objDigDemod.EqFilterLen = intVal

Remarks

Determine the length of the adaptive equalization filter of the digital demodulation measurement.  The Value is specified as an odd whole number of symbols.

This property is only useful if the adaptive equalizer is on (Equalize property).

Details about the equalization filter are available in the topic Using the Equalization Filter.

See Also

Filter Length


Equalize Property

(Vector only)

Get/set if equalizer is enabled.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod.Equalize
objDigDemod.Equalize = blnVal

Remarks

Determine whether the digital demodulation measurement uses adaptive equalization.  In addition to this property, you must set the EqAdaptive property to True to get the adaptive equalizer to run.

For more information, see About Adaptive Equalization

See Also

Using the Equalization Filter


FilterAlpha Property

(Vector only)

Get/set the filter alpha.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim sngVal As Single
sngVal = objDigDemod.FilterAlpha
objDigDemod.FilterAlpha = sngVal

Remarks

Determine the filter alpha for the digital demodulation measurement.  The alpha Value determines the filter characteristics of the Nyquist and Gaussian filters used by the digital demodulator.  For Gaussian filters, the term BT is used rather than alpha.

Filter Type	Allowable Values
non-Gaussian filters	0.05 to 1
Gaussian filters	0.05 to 100 Minimum increment: 0.01

For more information about filter characteristics, refer to the discussion entitled Alpha/BT in the online Volume, "Optional Features".

For more information about digital demodulation measurements, see Setting up a Digital Demod Measurement.

See Also

About Filters (Digital Demodulation)


FilterRegValid Property

(Vector only)

Gets wheither the data register is a valid measurement or reference filter.

Applies To:	DigDemod Object

Access:	Read only

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod.FilterRegValid(iReg)

Parameter	Data Type	Default Value	Description
iReg	Integer	None	An integer that specifies which data register to query.
Remarks

For digital demodulation, you can use data registers to create your own user-defined filter for the measured or reference filter.  You can use this property to see if a data register contains a Valid filter definition.  The property returns TRUE if the specified data register contains a Valid filter definition; it returns FALSE if it doesn't.

To have a Valid filter definition, a data register must contain a Valid, non-empty, complex, time-domain trace.

See Also

MeasFilterReg Property

RefFilterReg Property

User Defined Filters


Format Property

(Vector only)

Get/set the demod format.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemodFormat
enumVal = objDigDemod.Format
objDigDemod.Format = enumVal

Remarks

Determines the digital demodulation format.  You must set the format before setting any other demodulation properties or selecting trace data to display.

See Also

Format tab


GainImbQuadSkewPPSCoupled Property

(Vector only)

Get/Set if points per symbol coupling is enabled for gain imbalance and quadrature skew measurements.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod.GainImbQuadSkewPPSCoupled
objDigDemod.GainImbQuadSkewPPSCoupled = blnVal

Remarks

This property controls what measurement data is included in the Quadrature Skew and IQ Gain Imbalance error parameter calculations. True uses the number of points-per-symbol specified by the Points Per Symbol property in the calculations.  False uses the default number of Points per Symbol in calculations (the default values that the analyzer uses for points-per-symbol are shown in online help for the Points/Symbol parameter.

The default values are typically correct, but increased sensitivity to effects occurring between symbol decision points may be more apparent by choosing to couple the measurements to points per symbol.

See Also

Couple to Gain Imbalance/Quadrature Skew


MeasFilter Property

(Vector only)

Get/set the demod measurement filter.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemodMeasFilter
enumVal = objDigDemod.MeasFilter
objDigDemod.MeasFilter = enumVal

Remarks

Determine the type of digital demodulation measurement filter to apply.  If the measurement filter is VsaDigDemMeasFiltUserDefined, then the filter is constructed from the data register specified by the MeasFilterReg property.

Details about digital demodulation filtering are available in the topic Filtering Overview.

See Also

Measurement Filter

MeasFilterReg Property


MeasFilterReg Property

(Vector only)

Get/set the demod measurement filter data register (if MeasFilter is from a data register).

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim intVal As Integer
intVal = objDigDemod.MeasFilterReg
objDigDemod.MeasFilterReg = intVal

Remarks

Determine the data register to use for the digital demodulation measurement filter.  The data register is specified as an integer in the range of 1 through 8 representing the available data registers.  A Valid measurement filter must be a Valid non-empty complex time domain trace.

See Also

Measurement Filter Data Register

MeasFilterReg Property


MirrorFreq Property

(Vector only)

Get/set if demod will mirror the frequency spectrum.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod.MirrorFreq
objDigDemod.MirrorFreq = blnVal

Remarks

Determine whether the digital demodulation measurement will mirror the measurement data around the center frequency.

If you are demodulating a VSB signal that uses a high-side pilot, you must configure the analyzer to demodulate the high-side pilot by selecting mirror frequency spectrum. If you don't do this, the analyzer cannot find the pilot signal and cannot lock to your signal.

Note

Turning on Frequency.MirrorFreq will again mirror the frequency spectrum.  If you turn on both DigDemod.MirrorFreq and Frequency.MirrorFreq, the effect on digital demodulation is the same as if neither of the properties was set to True.

See Also

Mirror Frequency Spectrum

Setting up a Digital Demodulation Measurement


Normalize Property

(Vector only)

Get/set if demod will normalize the magnitude of the IQ data to the ideal state positions.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod.Normalize
objDigDemod.Normalize = blnVal

Remarks

This property controls the normalization of the IQ data to the ideal state positions.

See Also

For details about normalization, see  Normalization Overview.

For more information about digital demodulation, see Setting up a Digital Demodulation Measurement


PointsPerSymbol Property

(Vector only)

Get/set the points per symbol generated in the demod measurement data.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod.PointsPerSymbol
objDigDemod.PointsPerSymbol = lngVal

Remarks

Determine the number of output points per symbol generated by the digital demodulation measurement for the IQ/FSK measured time and IQ/FSK reference time results.  The allowable Values are: 1, 2, 4, 5, 10, and 20 points/symbol.

See Also

Points / Symbol


PulseSearch Property

(Vector only)

Get/set if pulse search is enabled.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod.PulseSearch
objDigDemod.PulseSearch = blnVal

Remarks

Determine whether the digital demodulation measurement will search for a pulse to find the beginning of the data.

Digital communication systems that use pulsed transmissions send and receive information in bursts (such as those in mobile units).  In other words, carrier power is switched on and off.  The carrier turns on when the transmitter transmits data; it turns off when the transmitter finishes transmitting data.  If pulse search is on, the analyzer searches within the defined search length to locate the first complete pulse which can occur anywhere in the search length.

Further details can be found in the topic entitled Pulse Search.

You may also want to consult Setting up a Digital Demod Measurement.


RefFilter Property

(Vector only)

Get/set the demod reference filter.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemodRefFilter
enumVal = objDigDemod.RefFilter
objDigDemod.RefFilter = enumVal

Remarks

Determine the type of digital demodulation reference filter to apply.  If the reference filter is VsaDigDemRefFiltUserDefined, then the filter is constructed from the data register specified by the RefFilterReg property.

Details about digital demodulation filtering are available in the topic About Filters.

See Also

Reference Filter

RefFilterReg Property


RefFilterReg Property

(Vector only)

Get/set the demod reference filter data register (if RefFilter is from a data register).

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim intVal As Integer
intVal = objDigDemod.RefFilterReg
objDigDemod.RefFilterReg = intVal

Remarks

Determine the data register to use for the digital demodulation reference filter.  The data register is specified as an integer in the range of 1 through 8 representing the available data registers.  A Valid reference filter must be a Valid non-empty complex time domain trace.

See Also

Reference Filter Data Register


ResultLen Property

(Vector only)

Get/set the demod measurement result length (in Sym).

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod.ResultLen
objDigDemod.ResultLen = lngVal

Remarks

For DigDemodOFDM ResultLenType must be set to vsaOFDMResultLenTypeManual for this to have any effect. This ResultLen is used as the number of symbols to demodulate, ignoring whatever burst length is encoded in the SIGNAL symbol.

Also See

Meas Setup->Demod Properties. . . ->Time tab


SearchLen Property

(Vector only)

Get the search length.

Applies To:	DigDemod Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objDigDemod.SearchLen

Remarks

The SearchLenUnit property returns the unit of the search length, either second or symbol.  The SetSearchLen method sets both the search length and the unit. The SearchLen is forced to be large enough to hold the maximum result length. The maximum result length is specified by ResultLen if ResultLenType is vsaOFDMResultLenTypeManual, or by MaxResultLen if ResultLenType is vsaOFDMResultLenTypeAuto.  Note that SearchLen is in seconds while the result length is in symbol times.  (One symbol time is (1+GuardInterval)/SubCarrierSpacing seconds.)

See Also

Search Length

SearchLenUnit Property

SetSearchLen Method

Meas Setup->Demod Properties. . . ->Time tab


SearchLenUnit Property

(Vector only)

Get the search length unit.

Applies To:	DigDemod Object

Access:	Read only

Syntax:	Dim enumVal As VsaDigDemSearchTimeUnit
enumVal = objDigDemod.SearchLenUnit

Remarks

The SearchLen property returns the length of the next recording.  The SetSearchLen method sets both the record length and the unit.

See Also

Search Length

SearchLen

SetSearchLen Method


StateDefLines Property

(Vector only)

Get the text description of the current state definitions.

Applies To:	DigDemod Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objDigDemod.StateDefLines

Remarks

Returns the current state definition as a string. This is the same information that is specified in a CSD (Constellation State Definitions) file if you elect to recall custom state definitions.

For most demodulation formats, the "state definitions" table represents the constellation diagram, and returns the bit definitions for each symbol in the constellation diagram.

For example, if the current demodulation format is QAM 16, the StateDefLines property will return a string similar to the following, which shows the bit definitions for each state in the QAM constellation diagram:

0011  0010  0001  0000

0111  0110  0101  0100

1011  1010  1001  1000

1111  1110  1101  1100

Each line is separation by a Carriage Return / Line Feed and each state on a line is separated by two spaces.

See Also

View State Definitions


SymbolRate Property

(Vector only)

Get/set the demod symbol rate.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemod.SymbolRate
objDigDemod.SymbolRate = dblVal

Remarks

Determines the input symbol rate, in Hertz, for the digital demodulation measurement.

The input that you select determines the maximum symbol rate that the analyzer can accurately measure.  The analyzer can accurately measure symbol rates that are less than the maximum span of the selected input.

For more information, see setting up a Digital Demodulation Measurement.


SyncOffset Property

(Vector only)

Get/set the sync search offset (in Sym).

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim intVal As Integer
intVal = objDigDemod.SyncOffset
objDigDemod.SyncOffset = intVal

Remarks

The analyzer lets you specify an offset, in symbols, when you use sync search in a digital demodulation measurement.  The offset determines the location of result length within search length. You can specify a positive or negative offset.  If the sync pattern occurs before the start of result length, specify a negative offset.  If it occurs after the start of result length, specify a positive offset.

The SyncOffset is only used if sync search is on (SyncSearch property set to True).

For additional details, see online help for the Search Tab.

See Also

SyncPatternName Property

SyncPattern Property


SyncPattern Property

(Vector only)

Get/Set the sync search binary pattern.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objDigDemod.SyncPattern
objDigDemod.SyncPattern = strVal

Remarks

Set or return a string of 1's and 0's to use as the synchronization pattern for sync search during digital demodulation.

Minimum length: 1 Symbol
Maximum length: 32 symbols

The pattern must be entered as binary digits. The software ignores all characters except ones (1) and zeroes (0).

See Also

Search Tab

SyncPatternName Property

SyncPatternName Propertys

SyncOffset Property


SyncPatternName Property

(Vector only)

Get/set the binary pattern for the specified sync search pattern name.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objDigDemod.SyncPatternName(sName)
objDigDemod.SyncPatternName(sName) = strVal

Parameter	Data Type	Default Value	Description
sName	String	None	String that names the specified sync search pattern
Remarks

You can set any number of sync patterns for the analyzer to remember.  Each pattern must have a unique name.

Use the SyncPatternNameRemove method to remove a named sync pattern.

See Also

Sync Search


SyncPatternNames Property

(Vector only)

Get the list of sync search pattern names.

Applies To:	DigDemod Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objDigDemod.SyncPatternNames

Remarks

Returns an array of strings containing the names of all named sync search patterns.  The SyncPatternName property can be used to access the pattern associated with each pattern name.  The SyncPatternNames can be used to iterate through the collection of patterns.

See Also

Sync Search


SyncSearch Property

(Vector only)

Get/set if sync search is enabled.

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod.SyncSearch
objDigDemod.SyncSearch = blnVal

Remarks

Determine whether sync search is enabled for the digital demodulation measurement.

The SyncPattern property determines the pattern to search for in the input data.

See Also

Sync Search

Search Tab

SyncPatternName Property

SyncPatternNames Property

SyncOffset Property

SyncPattern Property


UserRotate Property

(Vector only)

Get/set the demod user rotation value (in degrees).

Applies To:	DigDemod Object

Access:	Read/Write

Syntax:	Dim sngVal As Single
sngVal = objDigDemod.UserRotate
objDigDemod.UserRotate = sngVal

Remarks

Rotates the Meas/Ref Time data and corresponding ideal state positions 0 to 360 degrees.

See Also

Rotation Parameter


EqReset Method

(Vector only)

Reset the equalizer filter state.

Applies To:	DigDemod Object

Syntax:	objDigDemod.EqReset

Remarks

Reset the digital demodulation equalization filter state.  This method is ignored if the equalization filter is not turned on (Equalize property set to False).

For details, refer to the topic, Using the Equalization Filter.

See Also

Reset Equalizer


RecallStateDefFile Method

(Vector only)

Recall the current demod state definitions from a file.

Applies To:	DigDemod Object

Syntax:	objDigDemod.RecallStateDefFile(sName)

Parameter	Data Type	Default Value	Description
sName	String	None	The name of the file to recall.
Remarks

This method recalls the digital demodulation state definitions from a file.  You can recall a state definition file that was originally created for the 89400 analyzer.

The file contains lines that define the constellation state to symbol bit mapping for the different modulation formats.

See Also

Recall State Defs


SetSearchLen Method

(Vector only)

Set the search length and unit.

Applies To:	DigDemod Object

Syntax:	objDigDemod.SetSearchLen(dTime, eUnit)

Parameter	Data Type	Default Value	Description
dTime	Double	None	A double-precision number specifying the length of the search.
eUnit	VsaDigDemSearchTimeUnit	None	A constant from the VsaDigDemSrchTmUnit enumeration specifying the units of the search time as one of seconds or symbols.
Remarks

This method establishes the amount of data over which a search is performed when pulse search (PulseSearch property) or sync search (SyncSearch property) is on. The search length may be specified in second or symbol units.

See Also

Search Tab


SetStandard Method

(Vector only)

Set the demod properties based upon the specified demod standard.

Applies To:	DigDemod Object

Syntax:	objDigDemod.SetStandard(NewStandard)

Parameter	Data Type	Default Value	Description
NewStandard	VsaDigDemodStandards	None	A constant that specifies which digital-demodulation standard to use.
Remarks

This method lets you select one of the analyzers digital-demodulation standard setups.  Selecting a standard automatically configures the analyzer to demodulate that standard.  For example, specifying the constant VsaDigDemStaNADC configures the analyzer to demodulate NADC signals.

Most standards in the VsaDigDemodStandards enumeration are self explanatory.  Three that may be new to you are:

vsaDigDemSta80211b	Configures the analyzer to demodulate wireless LAN signals that conform to IEEE Std. 802.11b-1999.
vsaDigDemStaHIPERLANHBR	Configures the analyzer to demodulate HIgh PErformance Radio Local Area Network (HIPERLAN), High Bit Rate (HBR) signals, that conform to ETSI standard EN 600 352 V1.2.1 (1998-07).
vsaDigDemStaHIPERLANLBR	Configures the analyzer to demodulate HIgh PErformance Radio Local Area Network (HIPERLAN), Low Bit Rate (LBR) signals, that conform to ETSI standard EN 600 352 V1.2.1 (1998-07).
See Also

Preset to Standard


StateDefDefault Method

(Vector only)

Set the current demod state definitions to the default values.

Applies To:	DigDemod Object

Syntax:	objDigDemod.StateDefDefault

Remarks

This method restores the digital demodulation measurement's constellation state definitions to the default Values.

See Also

Preset State Defs


SyncPatternNameRemove Method

(Vector only)

Remove the specified sync search pattern name.

Applies To:	DigDemod Object

Syntax:	objDigDemod.SyncPatternNameRemove(sName)

Parameter	Data Type	Default Value	Description
sName	String	None	A string that specifies the sync search pattern.
Remarks

This method removes a previously named sync search pattern.

Use the SyncPatternName property to name sync patterns.

See Also

Search Tab

SyncPatternNameRemoveAll Method


SyncPatternNameRemoveAll Method

(Vector only)

Remove all sync search pattern names.

Applies To:	DigDemod Object

Syntax:	objDigDemod.SyncPatternNameRemoveAll

Remarks

This method removes all named sync search patterns.

Use the SyncPatternName property to name sync patterns.

See Also

Search Tab


DigDemod1xEVDO Object

(Vector only)

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
ActiveChannelDetectionMode †	RW	Gets/sets whether the active channel(s) are auto-detected or manually specified.
CDLWalshCodeLength †	RW	Gets/sets the CDP Layer Walsh Code Length.
ChipRate †	RW	Gets/sets the chip rate.
CompositeCombineTDM †	RW	Gets/sets whether all TDM channels are combined for composite results (forward only).
Direction †	RW	Gets/sets the link direction.
FwdActiveChannel †	RW	Gets/sets the active channel in the forward link direction.
FwdAnalysisChannel †	RW	Gets/sets the forward link analysis channel.
FwdDataModType †	RW	Gets/sets the forward link data channel modulation type.
IncludeIQOffset †	RW	Gets/sets whether EVM includes IQ offset.
IncludePreamble †	RW	Gets/sets whether preamble is included in Overall1/2 results (forward only).
IQBranch †	RW	Gets/sets the IQ branch.
IQCombined †	RW	Gets/sets whether IQ is combined.
LongCodeMask †	RW	Gets/sets the long code mask ( reverse link only - I).
LongCodeMaskQ †	RW	Gets/sets the long code mask ( reverse link only - Q).
MeasInterval †	RW	Gets/sets the measurement interval (in slots).
MeasOffset †	RW	Gets/sets the measurement offset (in slots).
MirrorFreq †	RW	Get/set if demod will mirror the frequency spectrum.
Normalize †	RW	Get/set if demod will normalize the magnitude of the IQ data to the ideal state positions.
PNOffset †	RW	Gets/sets the PN offset.
PreambleAutoDetect †	RW	Gets/sets whether the preamble is automatically detected.
PreambleLength †	RW	Gets/sets the preamble length. Used only if PreambleAutoDetect is false.
ResultLen †	RW	Gets/sets the result length (in slots).
RevActiveChannel †	RW	Gets/sets the active channel(s) in the reverse link direction. Used only if ActiveChannelDetectionMode is something other than Auto.
WalshCodeLength †	RW	Gets/sets the Walsh code length.
WalshCodeNumber †	RW	Gets/sets the Walsh code number.
Methods	Description
SetDefault †	Resets all demod properties to defaults for the indicated link direction.
Remarks

The DigDemod1xEVDO object provides access to the analyzer's 1xEV-DO digital-demodulation measurement features.  The 1xEV-DO display features are controlled through the Trace object.  These features are only available if option B7N (3G Digital Demodulation) is installed.

The AgtVsaScalar application does not have a DigDemod1xEVDO object.

When you first attempt to setup the DigDemod1xEVDO object, the first thing you should do is specify the link direction, using either the Direction property or the SetDefault method.  Using SetDefault is usually the best way to set the link direction, because it causes the other properties in this object to get set to default values for the standard and direction.

See Also

About Option B7N: 1xEV-DO Demodulation


ActiveChannelDetectionMode Property

(Vector only)

Gets/sets whether the active channel(s) are auto-detected or manually specified.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemod1xEVActiveChanDetectMode
enumVal = objDigDemod1xEVDO.ActiveChannelDetectionMode
objDigDemod1xEVDO.ActiveChannelDetectionMode = enumVal

Remarks

For forward link mode, pre-defined or automatic active channel detection choices are valid. For reverse link mode, pre-defined, semi-automatic, or automatic active channel detection choices are valid. Default is vsaDigDemod1xEVActiveChanDetectModeAuto.

See Also

Channel/Layer Tab

Active Channel Detection


CDLWalshCodeLength Property

(Vector only)

Gets/sets the CDP Layer Walsh Code Length.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod1xEVDO.CDLWalshCodeLength
objDigDemod1xEVDO.CDLWalshCodeLength = lngVal

Remarks

Sets the code layer to be used for CDP Layer traces. Limits for forward link analysis depend on Analysis Channel.  For reverse link, the minimum length is 4 and maximum is 16.

See Also

Channel/Layer Tab

Walsh Code Length

CDP Layer


ChipRate Property

(Vector only)

Gets/sets the chip rate.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemod1xEVDO.ChipRate
objDigDemod1xEVDO.ChipRate = dblVal

Remarks

Sets the Chip Rate for 1xEV-DO analysis in Hz. The default value for Chip Rate is 1.2288MHz.

See Also

Format Tab

Chip Rate


CompositeCombineTDM Property

(Vector only)

Gets/sets whether all TDM channels are combined for composite results (forward only).

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod1xEVDO.CompositeCombineTDM
objDigDemod1xEVDO.CompositeCombineTDM = blnVal

Remarks

Determines if composite results are generated using just portion of the slot specified by ?LINK?Analysis Channel, or if all time segments of the slot are utilized. Default is false, and measurements may take longer if this option is enabled. This only applies to forward link analysis.

See Also

Advanced Tab

Combine TDM Channels for Composite Results


Direction Property

(Vector only)

Gets/sets the link direction.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemod1xEVDirection
enumVal = objDigDemod1xEVDO.Direction
objDigDemod1xEVDO.Direction = enumVal

Remarks

Direction defaults to forward.  Certain properties apply to only forward or only reverse link analysis.  Likewise, certain results exist for only forward or only reverse link analysis.

See Also

Format Tab

Direction


FwdActiveChannel Property

(Vector only)

Gets/sets the active channel in the forward link direction.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemod1xEVFwdActiveChan
enumVal = objDigDemod1xEVDO.FwdActiveChannel
objDigDemod1xEVDO.FwdActiveChannel = enumVal

Remarks

This parameter only applies when the Active Channel Detection mode is set to pre-define and the direction is specified as forward. Default is vsaDigDemod1xEVFwdActiveChanNone.

See Also

Channel/Layer Tab

Active Channel Detection


FwdAnalysisChannel Property

(Vector only)

Gets/sets the forward link analysis channel.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDem1xEVFwdTDMChanType
enumVal = objDigDemod1xEVDO.FwdAnalysisChannel
objDigDemod1xEVDO.FwdAnalysisChannel = enumVal

Remarks

Sets the time domain channel to be used for analysis. This only applies to forward link measurements. Default is vsaDigDem1xEVFwdTDMChanTypePilot.

See Also

Format Tab

Analysis Channel


FwdDataModType Property

(Vector only)

Gets/sets the forward link data channel modulation type.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDem1xEVDataModType
enumVal = objDigDemod1xEVDO.FwdDataModType
objDigDemod1xEVDO.FwdDataModType = enumVal

Remarks

Sets the assumed Data channel modulation format for forward link analysis. Options include QPSK, 8PSK, and 16QAM, vsaDigDem1xEVDataModTypeQPSK is the default.

See Also

Format Tab

Data Modulation Type


IncludeIQOffset Property

(Vector only)

Gets/sets whether EVM includes IQ offset.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod1xEVDO.IncludeIQOffset
objDigDemod1xEVDO.IncludeIQOffset = blnVal

Remarks

Specified whether or not to include IQ origin offset in the computation of EVM. Default is true.

See Also

Advanced Tab

Include IQ Offset In EVM


IncludePreamble Property

(Vector only)

Gets/sets whether preamble is included in Overall1/2 results (forward only).

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod1xEVDO.IncludePreamble
objDigDemod1xEVDO.IncludePreamble = blnVal

Remarks

Default is true. If this value is false, the preamble portion of the 1xEV-DO burst is not included in the Overall results.

See Also

Advanced Tab

Include in Overall Results

About Overall Trace data


IQBranch Property

(Vector only)

Gets/sets the IQ branch.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemod3GIQBranch
enumVal = objDigDemod1xEVDO.IQBranch
objDigDemod1xEVDO.IQBranch = enumVal

Remarks

Selects the branch to be used for generating demodulated bits in code channel analysis.  This only applies to reverse link measurements. Default is vsaDigDemod3GIQBranchI.

See Also

Channel/Layer Tab

IQ Branch

About the Channel Symbol Table


IQCombined Property

(Vector only)

Gets/sets whether IQ is combined.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod1xEVDO.IQCombined
objDigDemod1xEVDO.IQCombined = blnVal

Remarks

Selects if forward link CDP traces should separate I and Q code power information. Default is true.  This only applies to forward link measurements with Data selected as the Analysis Channel

See Also

Advanced Tab

IQ Combined

About CDP Trace Data


LongCodeMask Property

(Vector only)

Gets/sets the long code mask ( reverse link only - I).

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objDigDemod1xEVDO.LongCodeMask
objDigDemod1xEVDO.LongCodeMask = strVal

Remarks

This specifies the long code mask for the I channel of reverse link measurements. Default is "3FFFFFFFFFF" and the mask may be any hexadecimal string between the range of "00000000000" and "3FFFFFFFFFF" .

See Also

Format Tab

LongCodeMask

LongCodeMaskQ

Setting up a 1xEV-DO Measurement


LongCodeMaskQ Property

(Vector only)

Gets/sets the long code mask ( reverse link only - Q).

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objDigDemod1xEVDO.LongCodeMaskQ
objDigDemod1xEVDO.LongCodeMaskQ = strVal

Remarks

This specifies the long code mask for the I channel of reverse link measurements.

See Also

Format Tab

LongCodeMask


MeasInterval Property

(Vector only)

Gets/sets the measurement interval (in slots).

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemod1xEVDO.MeasInterval
objDigDemod1xEVDO.MeasInterval = dblVal

Remarks

Default is 1. Interval can be specified in 0.5 slot increments. Specifies the length of the analysis interval for Channel results(Reverse link only), CDP, and reverse link code channel power results.

See Also

Time Tab

Measurement Offset

Measurement Interval

Result Length

Setting up a 1xEV-DO Measurement


MeasOffset Property

(Vector only)

Gets/sets the measurement offset (in slots).

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemod1xEVDO.MeasOffset
objDigDemod1xEVDO.MeasOffset = dblVal

Remarks

Default is 0. offset can be specified in 0.5 slot increments. Specifies the offset of the analysis interval for Channel(Reverse link only), CDP, and a subset of reverse link composite summary results.

See Also

Time Tab

Measurement Offset

Measurement Interval

Result Length

Setting up a 1xEV-DO Measurement


MirrorFreq Property

(Vector only)

Get/set if demod will mirror the frequency spectrum.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod1xEVDO.MirrorFreq
objDigDemod1xEVDO.MirrorFreq = blnVal

Remarks

Determine whether the digital demodulation measurement will mirror the measurement data around the center frequency. Default is false.

Note

Turning on Frequency.MirrorFreq will again mirror the frequency spectrum.  If you turn on both DigDemod1xEVDO.MirrorFreq and Frequency.MirrorFreq, the effect on digital demodulation is the same as if neither of the properties was set to True.

See Also

Format Tab

Mirror Frequency Spectrum

Mirror Frequency

Setting up a 1xEV-DO Measurement


Normalize Property

(Vector only)

Get/set if demod will normalize the magnitude of the IQ data to the ideal state positions.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod1xEVDO.Normalize
objDigDemod1xEVDO.Normalize = blnVal

Remarks

Default is true.

See Also

Format Tab

Normalize

Setting up a 1xEV-DO Measurement


PNOffset Property

(Vector only)

Gets/sets the PN offset.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod1xEVDO.PNOffset
objDigDemod1xEVDO.PNOffset = lngVal

Remarks

Specifies the PN offset to be applied to forward link analysis.  This much match the setting of the transmitter being analyzed to correctly measure the applied signal.

See Also

Format Tab

PN Offset

Setting up a 1xEV-DO Measurement


PreambleAutoDetect Property

(Vector only)

Gets/sets whether the preamble is automatically detected.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod1xEVDO.PreambleAutoDetect
objDigDemod1xEVDO.PreambleAutoDetect = blnVal

Remarks

This only applies to forward link analysis.  Default is true.  If PreambleAutoDetect is set to false, the value in PreambleLength is used to determine what time segments belong to Data and Preamble analysis channels.  This affects the CDP and Composite traces along with results in the Overall Error Summary trace.

See Also

Advanced Tab

Preamble Length

Preamble Include in Overall Results

Setting up a 1xEV-DO Measurement


PreambleLength Property

(Vector only)

Gets/sets the preamble length. Used only if PreambleAutoDetect is false.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod1xEVDO.PreambleLength
objDigDemod1xEVDO.PreambleLength = lngVal

Remarks

This only applies in forward link analysis when PreambleAutoDetect is set to false.  Default is 64. This determines what portion of the forward link slot is assumed to contain Preamble information.  Normally it is desired to let the analysis automatically determine Preamble channel information by leaving PreambleAutoDetect set to true.

See Also

Advanced Tab

Preamble Length

Preamble Include in Overall Results

Setting up a 1xEV-DO Measurement


ResultLen Property

(Vector only)

Gets/sets the result length (in slots).

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemod1xEVDO.ResultLen
objDigDemod1xEVDO.ResultLen = dblVal

Remarks

Determines how many slots are acquired for possible analysis.  Default is 5, minimum is 1, maximum depends upon the attached hardware.  Actual analyzed slots depend upon the selected Measurement Interval and Offset.

See Also

Time Tab

Measurement Interval

Measurement Offset

Result Length

Setting up a 1xEV-DO Measurement


RevActiveChannel Property

(Vector only)

Gets/sets the active channel(s) in the reverse link direction. Used only if ActiveChannelDetectionMode is something other than Auto.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemod1xEVRevActiveChan
enumVal = objDigDemod1xEVDO.RevActiveChannel
objDigDemod1xEVDO.RevActiveChannel = enumVal

Remarks

This parameter only applies when the Active Channel Detection mode is set to pre-define or semi-auto and the direction is specified as reverse. Default is vsaDigDemod1xEVRevActiveChanNone.  The value represents the or'd sum of the Channels selected to be pre-defined as active (bypassing the automatic active channel detection algorithm).

See Also

Channel/Layer Tab

Active Channel Detection


WalshCodeLength Property

(Vector only)

Gets/sets the Walsh code length.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod1xEVDO.WalshCodeLength
objDigDemod1xEVDO.WalshCodeLength = lngVal

Remarks

Sets the code layer to be used for code channel analysis. This only applies to reverse link measurements. Default is 16.

See Also

Channel/Layer Tab

Walsh Code Length


WalshCodeNumber Property

(Vector only)

Gets/sets the Walsh code number.

Applies To:	DigDemod1xEVDO Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod1xEVDO.WalshCodeNumber
objDigDemod1xEVDO.WalshCodeNumber = lngVal

Remarks

Sets the code channel number for code channel analysis. This only applies to reverse link measurements. Default is code channel 0. Limits depend on WalshCodeLength!JumpID(`').

See Also

Channel/Layer Tab

Walsh Code Number


SetDefault Method

(Vector only)

Resets all demod properties to defaults for the indicated link direction.

Applies To:	DigDemod1xEVDO Object

Syntax:	objDigDemod1xEVDO.SetDefault(newval)

Parameter	Data Type	Default Value	Description
newval	VsaDigDemod1xEVDirection	None	Sets the direction.  See the VsaDigDemod3GDirectionenum_VsaDigDemod3GDirection enumeration for valid values.
Remarks

By specifying a link direction as an argument, all demod properties associated with the direction are reset to their default values. Span is also set to a default of 1.5MHz.

See Also

Format Tab

Preset to Default

Direction

Span


DigDemod3G Object

(Vector only)

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
BaseCodeLength †	RW	Gets/sets the base code length (cdma2000 forward link only).
CDLSpreadCodeLength †	RW	Gets/sets the code domain layer spread code length.
CDLSymbolRate †	RW	Gets/sets the code domain layer symbol rate.
ChipRate †	RW	Gets/sets the chip rate.
CodeChannel †	RW	Gets/sets the code channel (3GPP only - see WalshCodeNumber property for cdma2000).
Direction †	RW	Gets/sets the link direction.
FilterAlpha †	RW	Gets/sets the filter alpha.
IQBranch †	RW	Gets/sets the IQ branch.
LongCode †	RW	Gets/sets the long code mask  (cdma2000 reverse link only).
MeasInterval †	RW	Gets/sets the measurement interval (in slots for 3GPP and PCG's for cdma2000).
MeasOffset †	RW	Gets/sets the measurement offset (in slots for 3GPP and PCG's for cdma2000).
MirrorFreq †	RW	Get/set if demod will mirror the frequency spectrum.
Normalize †	RW	Get/set if demod will normalize the magnitude of the IQ data to the ideal state positions.
ResultLen †	RW	Gets/sets the result length (in slots for 3GPP and PCG's for cdma2000).
ScrambleCode †	RW	Gets/sets the scramble code (for 3GPP only - see LongCode property for cdma2000).
ScrambleCodeOffset †	RW	Gets/sets the scramble code offset (3GPP downlink only).
ScrambleCodeType †	RW	Gets/sets the scramble code type (3GPP downlink only).
SpreadCodeLength †	RW	Gets/sets the spread code length (3GPP only - see WalshCodeLength property for cdma2000).
Standard †	RW	Gets/sets the current demod standard.
SymbolRate †	RW	Gets/sets the current symbol rate.
SyncType †	RW	Gets/sets the sync type (3GPP downlink only).
WalshCodeLength †	RW	Gets/sets the Walsh code length (cdma2000 only - see SpreadCodeLength property for 3GPP).
WalshCodeNumber †	RW	Gets/sets the Walsh code number (cdma2000 only - see CodeChannel property for 3GPP).
Methods	Description
SetDefault †	Resets all demod properties to defaults for the current standard and the indicated link direction.
Remarks

The DigDemod3G object provides access to the analyzer's W-CDMA and cdma2000 digital-demodulation measurement features.  The W-CDMA and cdma2000 display features are controlled through the Trace object.  These features are only available with option B7N (3G Digital Demodulation) are installed.

The AgtVsaScalar application does not have a DigDemod3G object.

When you create a new DigDemod3G object, the first thing you should do is specify which signal standard using the Standard property.  The next thing you should do is specify the link direction, using either the Direction property or the SetDefault method.  Using SetDefault is usually the best way to set the link direction, because it causes the other properties in this object to get set to default values for the standard and direction.


BaseCodeLength Property

(Vector only)

Gets/sets the base code length (cdma2000 forward link only).

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod3G.BaseCodeLength
objDigDemod3G.BaseCodeLength = lngVal

Remarks

This property lets you set or view the current base code length when demodulating cdma2000 forward-link signals.  The base code length determines the maximum Walsh Code Length that is analyzed and displayed in code-domain traces (CDP Composite, CDP Layer, and CDE Composite).

The only valid values for this property are 64 and 128.

The default value is 64.


CDLSpreadCodeLength Property

(Vector only)

Gets/sets the code domain layer spread code length.

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod3G.CDLSpreadCodeLength
objDigDemod3G.CDLSpreadCodeLength = lngVal

Remarks

This parameter is only used when demodulating W-CDMA and cdma2000 signals.  For W-CDMA (3GPP) signals, this property sets or returns the spread-code length displayed in the "CDP Layer" measurement data type.  For cdma2000 signals, this property sets or returns the Walsh-code length displayed in the "CDP Layer" measurement data type.

This property is inversely related to the CDLSymbolRate property - changing this property will change the CDLSymbolRate according to the following formula:

   CDLSymbolRate = ChipRate / CDLSpreadCodeLength

This parameter does not affect the actual demodulation, nor does it have any affect on what is displayed in the "CDP Composite" measurement data, it just determines what results are displayed in the "CDP Layer" measurement data.

You can change the CDLSpreadCodeLength after pausing a measurement, and the analyzer can compute and display new "CDP Layer" traces without having to acquire new data.

The minimum valid spread code length is four, except for the cdma2000 Reverse link where the minimum length is two.  The maximum valid spread code length is 512 for W-CDMA (3GPP) downlink, 256 for W-CDMA (3GPP) uplink, 128 or 64 for cdma2000 forward link, and 32 for cdma2000 reverse link.  For cdma2000 forward link, the maximum valid spread code length is determined by the BaseCodeLength property, which has a value of either 64 or 128.

The default value of this property is 256 for W-CDMA (3GPP) signals, 64 for cdma2000 forward link, and 32 for cdma2000 reverse link.


CDLSymbolRate Property

(Vector only)

Gets/sets the code domain layer symbol rate.

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemod3G.CDLSymbolRate
objDigDemod3G.CDLSymbolRate = dblVal

Remarks

This parameter is only used when demodulating W-CDMA and cdma2000 signals.  This property sets or returns the symbol rate that is displayed in the "CDP Layer" measurement data type.

This property is inversely related to the CDLSpreadCodeLength property - changing this property will change the CDLSpreadCodeLength according to the following formula:

   CDLSpreadCodeLength = ChipRate / CDLSymbolRate

This parameter does not affect the actual demodulation, nor does it have any affect on what is displayed in the "CDP Composite" measurement data, it just determines what results are displayed in the "CDP Layer" measurement data.

You can change the CDLSymbolRate after pausing a measurement, and the analyzer can compute and display new "CDP Layer" traces without having to acquire new data.

The valid CDLSymbolRate values are determined by the chip rate of the signal and the modulation type.  With the default chip rate of 3.84 MHz for W-CDMA (3GPP), the maximum symbol rate is 960 ksym/s for both downlink and uplink, and the minimum symbol rate is 7.5 ksym/s for downlink and 15 ksym/s for uplink. With the default chip rate of 1.2288 MHz for cdma2000, the maximum symbol rate is 307.2 ksym/s for forward link and 614.4 ksym/s for reverse link, and the minimum symbol rate is 9.6 or 19.2 ksym/s for the forward link and 38.4 ksym/s for the reverse link.  For cdma2000 forward link, the minimum valid symbol rate is determined partly by the BaseCodeLength property.  When the BaseCodeLength is 64, the minimum symbol rate is 19.2 ksym/s; when the BaseCodeLength is 128, the minimum symbol rate is 9.6 ksym/s.

The default value is 15 ksym/s for W-CDMA (3GPP) signals, 19.2 ksym/s for cdma2000 forward link, and 38.4 ksym/s for cdma2000 reverse link.


ChipRate Property

(Vector only)

Gets/sets the chip rate.

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemod3G.ChipRate
objDigDemod3G.ChipRate = dblVal

Remarks

Sets or returns the chip rate used for demodulating W-CDMA and cdma2000 signals.  Usually this would be left at the default value, which is 3.84 MHz for W-CDMA and 1.2288 MHz for cdma2000 signals.  Changing the chip rate changes the values of the CDLSymbolRate and SymbolRate properties proportionately.

The analyzer's frequency span should generally be set to a value greater than ChipRate * (1 + FilterAlpha).  Frequency spans less than that will result in possibly-aliased data, and all results will be marked with a DATA? trace LED.


CodeChannel Property

(Vector only)

Gets/sets the code channel (3GPP only - see WalshCodeNumber property for cdma2000).

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod3G.CodeChannel
objDigDemod3G.CodeChannel = lngVal

Remarks

Sets or returns the current code channel number for W-CDMA measurements.  For cdma2000 measurements, see online help for the WalshCodeNumber property.  This is the code channel that is displayed in the Channel IQ Meas Time, Channel IQ Ref Time, Channel Error Vector Time, Channel Magnitude Error, Channel Phase Error, and Channel Syms/Errs traces.

In addition to specifying the code channel number, you should also specify the symbol rate or spread code length (see the SymbolRate and SpreadCodeLength properties) to completely specify which CDMA channel is being analyzed.  For W-CDMA uplink you also should specify whether you want I or Q bits using the IQBranch propery.

You can change the CodeChannel after pausing a measurement, and the analyzer can compute and display new traces without having to acquire new data.

The minimum code channel number is zero.  The maximum is one less than the current setting of SpreadCodeLength.

The default value for CodeChannel is zero.


Direction Property

(Vector only)

Gets/sets the link direction.

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemod3GDirection
enumVal = objDigDemod3G.Direction
objDigDemod3G.Direction = enumVal

Remarks

This property applies only when doing W-CDMA (3GPP) or cdma2000 digital demodulation.  It specifies the link direction of the signal to be analyzed.  This is required because the formats of the uplink and downlink signals (W-CDMA) and forward and reverse link signals (cdma2000) are different.  Often it is better to use the SetDefault method, rather than setting the Direction property, so that all the other properties are set to default values for the particular link direction.

When analyzing W-CDMA signals, the valid values are vsaDigDemDir3GPPDown and vsaDigDemDir3GPPUp, corresponding to downlink and uplink respectively.  When analyzing cdma2000 signals, the valid values are vsaDigDemDirCdma2000Fwd and vsaDigDemDirCdma2000Rev, corresponding to forward link and reverse link respectively.

The default is vsaDigDemDir3GPPDown for W-CDMA and vsaDigDemDirCdma2000Fwd for cdma2000.


FilterAlpha Property

(Vector only)

Gets/sets the filter alpha.

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemod3G.FilterAlpha
objDigDemod3G.FilterAlpha = dblVal

Remarks

The FilterAlpha property is used to determine the filter characteristics of the root-raised-cosine filter in the W-CDMA measurement.  This property is ignored in cdma2000 measurements.

The allowable values are 0.05 to 1.  The default value is 0.22.

See Also

About Filters (Digital Demodulation)


IQBranch Property

(Vector only)

Gets/sets the IQ branch.

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemod3GIQBranch
enumVal = objDigDemod3G.IQBranch
objDigDemod3G.IQBranch = enumVal

Remarks

This property applies only when doing W-CDMA (3GPP) or cdma2000 digital demodulation.  It is used only for the W-CDMA uplink and the cdma2000 reverse link.  For these signals, the I and Q portions of each CDMA channel are logically separate bit-streams.  This property specifies which "branch" (I or Q) of the data to display bits for in the Channel Syms/Errs measurement data type.

You can change the IQBranch after pausing a measurement, and the analyzer can compute and display a new Channel Syms/Errs trace without having to acquire new data.

The valid values are vsaDigDemod3GIQBranchI and vsaDigDemod3GIQBranchQ, meaning to use the I or Q portion of the channel respectively.

The default is vsaDigDemod3GIQBranchQ for W-CDMA and vsaDigDemod3GIQBranchI for cdma2000.  (The default of Q for W-CDMA is because that's where the bits for DPCCH end up.)


LongCode Property

(Vector only)

Gets/sets the long code mask  (cdma2000 reverse link only).

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objDigDemod3G.LongCode
objDigDemod3G.LongCode = strVal

Remarks

This property is used when analyzing cdma2000 reverse-link signals.  The cdma2000 forward link does not use a long code.  When analyzing W-CDMA (3GPP) signals, use the ScrambleCode property instead.

The long code specifies a "scrambling" code that was applied to the signal.To demodulate the signal properly, the analyzer must know the code that was used by the transmitter.  At this time, only long code value zero is supported - any other value will result in unsuccessful demodulation.

The default value is zero.  This property uses a string of hexadecimal characters to represent the long code.


MeasInterval Property

(Vector only)

Gets/sets the measurement interval (in slots for 3GPP and PCG's for cdma2000).

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod3G.MeasInterval
objDigDemod3G.MeasInterval = lngVal

Remarks

This property applies only when analyzing W-CDMA (3GPP) , cdma2000, or OFDM signals.  For most of the possible measurement data types, it specifies the portion of the total ResultLength which is currently displayed.

When running a W-CDMA , cdma2000, or OFDM measurement, the analyzer acquires and analyzes data of length equal to the result length (see the ResultLen property).  A subset of this data is specified by the MeasInterval and MeasOffset properties.  This subset of data is what is actually displayed in a trace.  The MeasInterval is the number of timeslots, PCGs, or integer number of symbol times that are actually displayed. You can change the MeasInterval and MeasOffset after pausing a measurement, and the analyzer can compute and display new traces without having to acquire new data.

For DigDemod3G, the MeasInterval applies to the following measurement data traces:

•	CDP Composite, CDP Layer

•	All channel results (IQ Meas Time, etc)

•	Pre-demod Time and Spectrum

For DigDemod3G, the MeasInterval does not apply to the following measurement data traces:

•	CDE Composite

•	All composite time results, including composite error summary

For OFDM, the MeasInterval applies to all measurement data traces.

For W-CDMA (3GPP), the MeasInterval is expressed in terms of timeslots, which are equal to 2560 chips each.  For cdma2000, the MeasInterval is expressed in terms of Power Control Groups (PCGs), which are equal to 1536 chips each. For OFDM, the MeasInterval is expressed in terms of integer number of symbol times.

The minimum valid MeasInterval is one, the maximum is equal to the current ResultLen.  The sum of MeasOffset plus MeasInterval must always be less than or equal to the ResultLength.

For W-CDMA the default MeasInterval is one timeslot. For cdma2000 the default MeasInterval is one PCG. For OFDM the default MeasInterval is 60 symbol times.

See Also

MeasOffset

Meas Setup->Demod Properties. . . ->Time tab


MeasOffset Property

(Vector only)

Gets/sets the measurement offset (in slots for 3GPP and PCG's for cdma2000).

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod3G.MeasOffset
objDigDemod3G.MeasOffset = lngVal

Remarks

This property applies only when analyzing W-CDMA (3GPP) , cdma2000, or OFDM signals.  For most of the possible measurement data types, it specifies the offset to the portion of the total ResultLength which is currently displayed.

When running a W-CDMA,  cdma2000, or OFDM measurement, the analyzer acquires and analyzes data of length equal to the result length (see the ResultLen property).  A subset of this data is specified by the MeasInterval and MeasOffset properties.  This subset of the data is what is actually displayed in the analyzer traces.  The MeasOffset is the number of timeslots, PCGs, or integer number of symbol times between the start of the ResultLen and the start of the displayed data.  You can change the MeasInterval and MeasOffset after pausing a measurement, and the analyzer can compute and display new traces without having to acquire new data.

For DigDemod3G, the MeasOffset applies to the following measurement data traces:

•	CDP Composite, CDP Layer

•	All channel results (IQ Meas Time, etc)

•	Pre-demod Time and Spectrum

For DigDemod3G, the MeasOffset does not apply to the following measurement data traces:

•	CDE Composite

•	All composite time results, including composite error summary

For OFDM, the MeasOffset applies to all measurement data traces.

For W-CDMA (3GPP), the MeasOffset is expressed in terms of timeslots, which are equal to 2560 chips each.  For cdma2000, the MeasOffset is expressed in terms of Power Control Groups (PCGs), which are equal to 1536 chips each. For OFDM the MeasOffset is expressed in terms of an integer number of symbol times.

For W-CDMA and cdma2000 the minimum valid MeasOffset is zero, the maximum is equal to the current ResultLength minus one timeslot.  The value is an integer - no fractional timeslots can be specified.  The sum of MeasOffset plus MeasInterval must always be less than or equal to the ResultLength.

For DigDemodOFDM a negative measurement offset value may be indicated to view the preamble.

The default MeasOffset value for DigDemod3G and OFDM is zero.

See Also

MeasInterval

Meas Setup->Demod Properties. . . ->Time tab


MirrorFreq Property

(Vector only)

Get/set if demod will mirror the frequency spectrum.

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod3G.MirrorFreq
objDigDemod3G.MirrorFreq = blnVal

Remarks

Determine whether the digital demodulation measurement will mirror the measurement data around the center frequency.

If you are demodulating a VSB signal that uses a high-side pilot, you must configure the analyzer to demodulate the high-side pilot by selecting mirror frequency spectrum. If you don't do this, the analyzer cannot find the pilot signal and cannot lock to your signal.

Note

Turning on Frequency.MirrorFreq will again mirror the frequency spectrum.  If you turn on both DigDemod.MirrorFreq and Frequency.MirrorFreq, the effect on digital demodulation is the same as if neither of the properties was set to True.

See Also

Mirror Frequency Spectrum

Setting up a Digital Demodulation Measurement


Normalize Property

(Vector only)

Get/set if demod will normalize the magnitude of the IQ data to the ideal state positions.

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemod3G.Normalize
objDigDemod3G.Normalize = blnVal

Remarks

This property controls the normalization of IQ, CDP, and CDE data as follows:

•	Channel IQ data is normalized to the ideal state positions.

•	Composite IQ data is normalized to have an RMS level of one.

•	CDP and CDE data is normalized to a total power of one.

See Also

For details about normalization, see  Normalization Overview.

For more information about digital demodulation, see Setting up a Digital Demodulation Measurement

Meas Setup->Demod Properties. . . ->Advanced tab


ResultLen Property

(Vector only)

Gets/sets the result length (in slots for 3GPP and PCG's for cdma2000).

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod3G.ResultLen
objDigDemod3G.ResultLen = lngVal

Remarks

For DigDemodOFDM ResultLenType must be set to vsaOFDMResultLenTypeManual for this to have any effect. This ResultLen is used as the number of symbols to demodulate, ignoring whatever burst length is encoded in the SIGNAL symbol.

Also See

Meas Setup->Demod Properties. . . ->Time tab


ScrambleCode Property

(Vector only)

Gets/sets the scramble code (for 3GPP only - see LongCode property for cdma2000).

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod3G.ScrambleCode
objDigDemod3G.ScrambleCode = lngVal

Remarks

This property is used when analyzing W-CDMA (3GPP) signals.  When analyzing cdma2000 signals, use the LongCode property instead.

The scramble code specifies a unique code that was applied to the signal.  To demodulate the signal properly, the analyzer must know the code that was used by the transmitter.  For W-CDMA Downlink, the ScrambleCode is used together with the ScrambleCodeOffset and ScrambleCodeType to produce the unique code which is used to unscramble the signal.  For W-CDMA Uplink, the ScrambleCode is used by itself, without the ScrambleCodeOffset and ScrambleCodeType.

The minimum valid scramble code is 0.  The maximum valid scramble code is 511 for W-CDMA downlink and 16777215 for W-CDMA uplink.

The default value is zero.


ScrambleCodeOffset Property

(Vector only)

Gets/sets the scramble code offset (3GPP downlink only).

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod3G.ScrambleCodeOffset
objDigDemod3G.ScrambleCodeOffset = lngVal

Remarks

This property is used only when analyzing W-CDMA (3GPP) downlink signals.  The scramble code offset helps specifies the scrambling code that was applied to the signal by the transmitter.  To demodulate the signal properly, the analyzer must know this code.  The ScrambleCodeOffset is used together with the ScrambleCode and ScrambleCodeType to produce the scrambling code which is used to unscramble the signal.

The minimum valid scramble code offset is 0.  The maximum valid scramble code offset is 15.

The default value is zero.


ScrambleCodeType Property

(Vector only)

Gets/sets the scramble code type (3GPP downlink only).

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemod3GppScrambleCodeType
enumVal = objDigDemod3G.ScrambleCodeType
objDigDemod3G.ScrambleCodeType = enumVal

Remarks

This property is used only when analyzing W-CDMA (3GPP) downlink signals.  The scramble code type helps specifies the scrambling code that was applied to the signal by the transmitter.  To demodulate the signal properly, the analyzer must know this code.  The ScrambleCodeType is used together with the ScrambleCode and ScrambleCodeOffset to produce the scrambling code which is used to unscramble the signal.

The valid values are vsaDigDemod3GppScrambleCodeTypeStd, vsaDigDemod3GppScrambleCodeTypeLeft, and vsaDigDemod3GppScrambleCodeTypeRight.

The default value is vsaDigDemod3GppScrambleCodeTypeStd.


SpreadCodeLength Property

(Vector only)

Gets/sets the spread code length (3GPP only - see WalshCodeLength property for cdma2000).

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod3G.SpreadCodeLength
objDigDemod3G.SpreadCodeLength = lngVal

Remarks

Sets or returns the current spread code length for W-CDMA measurements.  For cdma2000 measurements, see online help for the WalshCodeLength property.  This is the spread code length that is used for the Channel IQ Meas Time, Channel IQ Ref Time, Channel Error Vector Time, Channel Magnitude Error, Channel Phase Error, and Channel Syms/Errs traces.

In addition to specifying the spread code length, you should also specify the code channel number (see the CodeChannel property) to completely specify which CDMA channel is being analyzed.  For W-CDMA uplink you also should specify whether you want I or Q bits using the IQBranch propery.

You can change the SpreadCodeLength after pausing a measurement, and the analyzer can compute and display new traces without having to acquire new data.

This property is inversely related to the SymbolRate property - changing this property will change the SymbolRate according to the following formula:

   SymbolRate = Chiprate / SpreadCodeLength

The SpreadCodeLength is not used for the "CDP Layer" measurement data type.  Instead, CDLSpreadCodeLength is used for "CDP Layer", so that you can look at a different spread code length in "CDP Layer" than is used for the Channel time measurement data.

The minimum spread code length is 4.  The maximum is 512 for W-CDMA downlink and 256 for W-CDMA uplink.

The default value for SpreadCodeLength is 256.


Standard Property

(Vector only)

Gets/sets the current demod standard.

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemod3GStandards
enumVal = objDigDemod3G.Standard
objDigDemod3G.Standard = enumVal

Remarks

Gets or returns the current standard that is analyzed by the DigDemod3G object or the DigDemodOFDM object. For the DigDemod3G object, the value vsaDigDemSta3GPP means the object will analyze W-CDMA (3GPP) signals, and the value vsaDigDemStaCdma2000 means the object will analyze cdma2000 signals. For DigDemodOFDM, vsaOFDMSta80211a and vsaOFDMStaHIPERLAN2 indicate the available standards that will be analyzed. Typically this is the first property that is set in a DigDemod3G or DigDemodOFDM object, because this property fundamentally affects many of the other properties.  For example, many of the minimum and maximum values for properties are different for cdma2000 than they are for W-CDMA. For the DigDemod3G object, after setting the Standard property you should specify the link direction using either the Direction property, or (more likely) the SetDefault method.

See Also

MeasSetup->Demod Properties. . . ->Format tab


SymbolRate Property

(Vector only)

Gets/sets the current symbol rate.

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemod3G.SymbolRate
objDigDemod3G.SymbolRate = dblVal

Remarks

Sets or returns the current symbol rate for W-CDMA and cdma2000 measurements.  This is the symbol rate that is used for the Channel IQ Meas Time, Channel IQ Ref Time, Channel Error Vector Time, Channel Magnitude Error, Channel Phase Error, and Channel Syms/Errs traces.

In addition to specifying the symbol rate, you should also specify the code channel number (see the CodeChannel property) to completely specify which CDMA channel is being analyzed.  For W-CDMA uplink you also should specify whether you want I or Q bits using the IQBranch propery.

You can change the SymbolRate after pausing a measurement, and the analyzer can compute and display new traces without having to acquire new data.

This property is inversely related to the SpreadCodeLength property - changing this property will change the SpreadCodeLength according to the following formula:

   SpreadCodeLength = ChipRate / SymbolRate

The SymbolRate is not used for the "CDP Layer" measurement data type.  Instead, CDLSymbolRate is used for "CDP Layer", so that you can look at a different symbol rate in "CDP Layer" than is used for the Channel time measurement data.

The maximum symbol rate is 960 ksym/s.  The minimum is 7.5 ksym/s for W-CDMA downlink and 15 ksym/s for W-CDMA uplink.

The default value for SymbolRate is 15 ksym/s.


SyncType Property

(Vector only)

Gets/sets the sync type (3GPP downlink only).

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemod3GppSyncType
enumVal = objDigDemod3G.SyncType
objDigDemod3G.SyncType = enumVal

Remarks

This property is used in W-CDMA (3GPP) and OFDM measurements.  This property specifies the synchronization method to be used when demodulating the signal.

The valid sync types for 3GPP are vsaDigDemod3GppSyncTypeCPICH and vsaDigDemod3GppSyncTypeSCH.  Most W-CDMA signals have a CPICH channel, so vsaDigDemod3GppSyncTypeCPICH is generally the best synchronization type to use.  Some W-CDMA signals don't have a CPICH channel, so for those signals you must use the vsaDigDemod3GppSyncTypeSCH.  If neither CPICH nor SCH channels are present in the signal, the analyzer will not be able to demodulate the signal.

The default value for 3GPP is vsaDigDemod3GppSyncTypeCPICH.

The valid sync types for OFDM are vsaOFDMSyncTypeShort and vsaOFDMSyncTypeChanEst (“ChanEst” stands for channel estimation, which is also called the “long sync” type). These are different methods of synchronizing to the start of an OFDM burst. The vsaOFDMSyncShortType method synchronizes to the”short sync” part of the preamble. The vsaOFDMSyncChanEst method synchronizes to the “channel estimation” part of the preamble. Either sync type is valid for 802.11a. Only vsaOFDMSyncTypeChanEst is valid for HIPERLAN/2, because the HIPERLAN/2 signal does not always contain a short sync in the preamble.

The default value for OFDM is the “short type”, vsaOFDMSyncTypeShort.

See Also

Sync Search

Search Tab

Meas Setup->Demod Properties. . . ->Advanced tab


WalshCodeLength Property

(Vector only)

Gets/sets the Walsh code length (cdma2000 only - see SpreadCodeLength property for 3GPP).

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod3G.WalshCodeLength
objDigDemod3G.WalshCodeLength = lngVal

Remarks

Sets or returns the current Walsh code length for cdma2000 measurements.  For W-CDMA (3GPP) measurements, see online help for the SpreadCodeLength property.  This is the Walsh code length that is used for the Channel IQ Meas Time, Channel IQ Ref Time, Channel Error Vector Time, Channel Magnitude Error, Channel Phase Error, and Channel Syms/Errs traces.

In addition to specifying the Walsh code length, you should also specify the Walsh code number (see the WalshCodeNumber property) to completely specify which CDMA channel is being analyzed.  For cdma2000 reverse link you also should specify whether you want I or Q bits using the IQBranch property.

You can change the WalshCodeLength after pausing a measurement, and the analyzer can compute and display new traces without having to acquire new data.

This property is inversely related to the SymbolRate property - changing this property will change the SymbolRate according to the following formula:

   SymbolRate = ChipRate / WalshCodeLength

The WalshCodeLength is not used for the "CDP Layer" measurement data type.  Instead, CDLSpreadCodeLength is used for "CDP Layer", so that you can look at a different Walsh code length in "CDP Layer" than is used for the Channel time measurement data.

The minimum Walsh code length is 4 for forward link and 2 for reverse link.  For the forward link, the maximum valid Walsh code length is determined by the BaseCodeLength property, which has a value of either 64 or 128.  For the reverse link, the maximum valid Walsh code length is 32.

The default value for WalshCodeLength is 64 for forward link and 32 for reverse link.


WalshCodeNumber Property

(Vector only)

Gets/sets the Walsh code number (cdma2000 only - see CodeChannel property for 3GPP).

Applies To:	DigDemod3G Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemod3G.WalshCodeNumber
objDigDemod3G.WalshCodeNumber = lngVal

Remarks

Sets or returns the current Walsh code number for cdma2000 measurements.  For W-CDMA (3GPP) measurements, see online help for the CodeChannel property.  This is the Walsh code number that is displayed in the Channel IQ Meas Time, Channel IQ Ref Time, Channel Error Vector Time, Channel Magnitude Error, Channel Phase Error, and Channel Syms/Errs traces.

In addition to specifying the Walsh code number, you should also specify the symbol rate or Walsh code length (see the SymbolRate and WalshCodeLength properties) to completely specify which CDMA channel is being analyzed.  For cdma2000 reverse link you also should specify whether you want I or Q bits using the IQBranch property.

You can change the WalshCodeNumber after pausing a measurement, and the analyzer can compute and display new traces without having to acquire new data.

The minimum Walsh code number is zero.  The maximum is one less than the current setting of WalshCodeLength.

The default value is zero.


SetDefault Method

(Vector only)

Resets all demod properties to defaults for the current standard and the indicated link direction.

Applies To:	DigDemod3G Object

Syntax:	objDigDemod3G.SetDefault(newval)

Parameter	Data Type	Default Value	Description
newval	VsaDigDemod3GDirection	None	Sets the direction.  See the VsaDigDemod3GDirectionenum_VsaDigDemod3GDirection enumeration for valid values.
Remarks

For the DigDemod3G object this method resets all properties to default values appropriate for the current Standard and the Direction specified as the parameter.  In addition, the frequency span of the analyzer is set to a default value appropriate for the current Standard.

See Also

Standard Property

Meas Setup->Demod Properties. . . ->Format tab


DigDemodDSSS Object

(Vector only)

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
ChipRate †	RW	Gets/sets the chip rate.
ClockAdjust †	RW	Get/set the clock adjustment (in chips).
DataModFormat †	RW	Gets/sets the data rate. This property only applies if DataModType is set to vsaDSSSDataModTypeManual.
DataModType †	RW	Gets/sets whether the data rate is determined automatically, or manually according to the DataModFormat property.
DescrambleMode †	RW	Get/set the type of descrambling performed on the signal.
EqFilterLen †	RW	Get/set the equalizer filter length (in chips).
Equalize †	RW	Get/set if equalizer is enabled.
MaxResultLen †	RW	Gets/sets the maximum result length, expressed as an integer number of chips.
MeasInterval †	RW	Gets/sets the measurement interval as an integer number of chips.
MeasOffset †	RW	Gets/sets the measurement offset expressed as an integer number of chips.
MirrorFreq †	RW	Get/set if demod will mirror the frequency spectrum.
Normalize †	RW	Get/set if demod will normalize the magnitude of the IQ data to the ideal state positions.
ResultLen †	RW	Gets/sets the result length to use expressed as an integer number of chips. Only effective if ResultLenType is set to vsaDSSSResultLenTypeManual.
ResultLenType †	RW	Gets/sets whether the result length is determined automatically, or is set manually according to the Resultlen property.
SearchLen †	RW	Gets/sets the search length in seconds.
TrackPhase †	RW	Get/set whether phase tracking is enabled.
Methods	Description
SetDefault †	Preset all measurement attributes to default values for indicated standard.
Remarks

To learn how this feature works, see online help for the dialog box that lets you access this object.


ChipRate Property

(Vector only)

Gets/sets the chip rate.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemodDSSS.ChipRate
objDigDemodDSSS.ChipRate = dblVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


ClockAdjust Property

(Vector only)

Get/set the clock adjustment (in chips).

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemodDSSS.ClockAdjust
objDigDemodDSSS.ClockAdjust = dblVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


DataModFormat Property

(Vector only)

Gets/sets the data rate. This property only applies if DataModType is set to vsaDSSSDataModTypeManual.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDSSSDataModFmt
enumVal = objDigDemodDSSS.DataModFormat
objDigDemodDSSS.DataModFormat = enumVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


DataModType Property

(Vector only)

Gets/sets whether the data rate is determined automatically, or manually according to the DataModFormat property.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDSSSDataModType
enumVal = objDigDemodDSSS.DataModType
objDigDemodDSSS.DataModType = enumVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


DescrambleMode Property

(Vector only)

Get/set the type of descrambling performed on the signal.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDSSSDescrMode
enumVal = objDigDemodDSSS.DescrambleMode
objDigDemodDSSS.DescrambleMode = enumVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


EqFilterLen Property

(Vector only)

Get/set the equalizer filter length (in chips).

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodDSSS.EqFilterLen
objDigDemodDSSS.EqFilterLen = lngVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


Equalize Property

(Vector only)

Get/set if equalizer is enabled.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodDSSS.Equalize
objDigDemodDSSS.Equalize = blnVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


MaxResultLen Property

(Vector only)

Gets/sets the maximum result length, expressed as an integer number of chips.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodDSSS.MaxResultLen
objDigDemodDSSS.MaxResultLen = lngVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


MeasInterval Property

(Vector only)

Gets/sets the measurement interval as an integer number of chips.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodDSSS.MeasInterval
objDigDemodDSSS.MeasInterval = lngVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


MeasOffset Property

(Vector only)

Gets/sets the measurement offset expressed as an integer number of chips.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodDSSS.MeasOffset
objDigDemodDSSS.MeasOffset = lngVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


MirrorFreq Property

(Vector only)

Get/set if demod will mirror the frequency spectrum.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodDSSS.MirrorFreq
objDigDemodDSSS.MirrorFreq = blnVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


Normalize Property

(Vector only)

Get/set if demod will normalize the magnitude of the IQ data to the ideal state positions.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodDSSS.Normalize
objDigDemodDSSS.Normalize = blnVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


ResultLen Property

(Vector only)

Gets/sets the result length to use expressed as an integer number of chips. Only effective if ResultLenType is set to vsaDSSSResultLenTypeManual.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodDSSS.ResultLen
objDigDemodDSSS.ResultLen = lngVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


ResultLenType Property

(Vector only)

Gets/sets whether the result length is determined automatically, or is set manually according to the Resultlen property.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDSSSResultLenType
enumVal = objDigDemodDSSS.ResultLenType
objDigDemodDSSS.ResultLenType = enumVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


SearchLen Property

(Vector only)

Gets/sets the search length in seconds.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemodDSSS.SearchLen
objDigDemodDSSS.SearchLen = dblVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


TrackPhase Property

(Vector only)

Get/set whether phase tracking is enabled.

Applies To:	DigDemodDSSS Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodDSSS.TrackPhase
objDigDemodDSSS.TrackPhase = blnVal

Remarks


SetDefault Method

(Vector only)

Preset all measurement attributes to default values for indicated standard.

Applies To:	DigDemodDSSS Object

Syntax:	objDigDemodDSSS.SetDefault([newval])

Parameter	Data Type	Default Value	Description
newval	VsaDSSSStandards	0	Sets the direction.  See the VsaDigDemod3GDirectionenum_VsaDigDemod3GDirection enumeration for valid values.
Remarks

To learn how this feature works, see online help for the dialog box that lets you execute this function.


DigDemodOFDM Object

(Vector only)

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
GuardInterval †	RW	Gets/set the guard interval, expressed as a fraction of the IFFT time length.
MaxResultLen †	RW	Gets/sets the maximum result length, expressed as an integer number of symbol times.
MeasInterval †	RW	Gets/sets the measurement interval as an integer number of symbol times.
MeasOffset †	RW	Gets/sets the measurement offset expressed as an integer number of symbol times.
MirrorFreq †	RW	Get/set if demod will mirror the frequency spectrum.
Normalize †	RW	Get/set if demod will normalize the magnitude of the IQ data to the ideal state positions. Also controls normalization of the error vector.
PilotTrackAmpl †	RW	Get/sets whether pilot amplitude tracking is enabled.
PilotTrackPhase †	RW	Get/sets whether pilot phase tracking is enabled.
PilotTrackTiming †	RW	Gets/sets whether pilot timing tracking is enabled.
ResultLen †	RW	Gets/sets the result length to use expressed as an integer number of symbol times.
ResultLenType †	RW	Gets/sets whether to automatically determine the result length, or to specify it explicitly using the ResultLen property.
SearchLen †	RW	Gets/sets the search length in seconds.
Standard †	RW	Gets/sets the demod standard to apply.
SubCarrierModFormat †	RW	Gets/sets the subcarrier modulation format.
SubCarrierModType †	RW	Gets/sets whether the subcarrier modulation format is determined automatically or set explicitly using the SubCarrierModFormat property.
SubCarrierNum †	RW	Gets/sets which subcarrier to analyze (meaningful only if looking at a single subcarrier - specified using SubCarrierSet property).
SubCarrierSet †	RW	Gets/sets whether to look at all subcarriers, just a single subcarrier (specified with SubCarrierNum property), or just pilot subcarriers.
SubCarrierSpacing †	RW	Gets/sets subcarrier spacing in Hz.
SymbolTimeAdjust †	RW	Gets/sets the IFFT offset within the symbol time expressed as a percentage of the IFFT time length.
SyncType †	RW	Gets/sets which part of the preamble is used for synchronization.
Methods	Description
SetDefault †	Preset all measurement attributes to default values for indicated standard.
Remarks

The DigDemodOFDM object provides access to the analyzer's digital demodulation OFDM measurement features.  These features are only available with option B7R (WLAN).  As well as measuring standard OFDM formats, you can customize the analyzer to measure non-ideal and non-standard signals.

The AgtVsaScalar application does not have a DigDemodOFDM object.

The digital demodulationOFDM display features are controlled through the Trace object. Among the settings critical to accurate OFDM measurements are frequency span, input range, search length, subcarrier spacing, and guard interval.


GuardInterval Property

(Vector only)

Gets/set the guard interval, expressed as a fraction of the IFFT time length.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemodOFDM.GuardInterval
objDigDemodOFDM.GuardInterval = dblVal

Remarks

Valid values are between 0 and 1.  The default value is 0.25, which matches the IEEE 802.11g standards.

See Also

MeasSetup->Demod.Properties->Format


MaxResultLen Property

(Vector only)

Gets/sets the maximum result length, expressed as an integer number of symbol times.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodOFDM.MaxResultLen
objDigDemodOFDM.MaxResultLen = lngVal

Remarks

ResultLenType must be set to vsaOFDMResultLenTypeAuto for this to have any effect.

See Also

ResultLenType Property

Meas Setup->Demod Properties. . . ->Time tab


MeasInterval Property

(Vector only)

Gets/sets the measurement interval as an integer number of symbol times.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodOFDM.MeasInterval
objDigDemodOFDM.MeasInterval = lngVal

Remarks

This property applies only when analyzing W-CDMA (3GPP) , cdma2000, or WLAN signals.  For most of the possible measurement data types, it specifies the portion of the total ResultLength which is currently displayed.

When running a W-CDMA , cdma2000, or WLAN measurement, the analyzer acquires and analyzes data of length equal to the result length (see the ResultLen property).  A subset of this data is specified by the MeasInterval and MeasOffset properties.  This subset of data is what is actually displayed in a trace.  The MeasInterval is the number of timeslots, PCGs, integer number of symbol times, or chip times, that are actually displayed. You can change the MeasInterval and MeasOffset after pausing a measurement, and the analyzer can compute and display new traces without having to acquire new data.

For DigDemod3G, the MeasInterval applies to the following measurement data traces:

•	CDP Composite, CDP Layer

•	All channel results (IQ Meas Time, etc)

•	Pre-demod Time and Spectrum

For DigDemod3G, the MeasInterval does not apply to the following measurement data traces:

•	CDE Composite

•	All composite time results, including composite error summary

For OFDM, the MeasInterval applies to all measurement data traces.

For W-CDMA (3GPP), the MeasInterval is expressed in terms of timeslots, which are equal to 2560 chips each.  For cdma2000, the MeasInterval is expressed in terms of Power Control Groups (PCGs), which are equal to 1536 chips each. For WLAN-OFDM, the MeasInterval is expressed in terms of integer number of symbol times.  For WLAN-DSSS/CCK/PBCC, the MeasInterval is expressed in terms of chips.

The minimum valid MeasInterval is one, the maximum is equal to the current ResultLen.  The sum of MeasOffset plus MeasInterval must always be less than or equal to the ResultLength.

For W-CDMA the default MeasInterval is one timeslot. For cdma2000 the default MeasInterval is one PCG. For WLAN-OFDM the default MeasInterval is 60 symbol times.  For WLAN-DSSS/CCK/PBCC, the default MeasInterval is 2794 chips.

See Also

MeasOffset

Meas Setup->Demod Properties. . . ->Time tab


MeasOffset Property

(Vector only)

Gets/sets the measurement offset expressed as an integer number of symbol times.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodOFDM.MeasOffset
objDigDemodOFDM.MeasOffset = lngVal

Remarks

This property applies only when analyzing W-CDMA (3GPP) , cdma2000, or WLAN signals.  For most of the possible measurement data types, it specifies the offset to the portion of the total ResultLength which is currently displayed.

When running a W-CDMA,  cdma2000, or WLAN measurement, the analyzer acquires and analyzes data of length equal to the result length (see the ResultLen property).  A subset of this data is specified by the MeasInterval and MeasOffset properties.  This subset of the data is what is actually displayed in the analyzer traces.  The MeasOffset is the number of timeslots, PCGs, integer number of symbol times, or chip times between the start of the ResultLen and the start of the displayed data.  You can change the MeasInterval and MeasOffset after pausing a measurement, and the analyzer can compute and display new traces without having to acquire new data.

For DigDemod3G, the MeasOffset applies to the following measurement data traces:

•	CDP Composite, CDP Layer

•	All channel results (IQ Meas Time, etc)

•	Pre-demod Time and Spectrum

For DigDemod3G, the MeasOffset does not apply to the following measurement data traces:

•	CDE Composite

•	All composite time results, including composite error summary

For OFDM, the MeasOffset applies to all measurement data traces.

For W-CDMA (3GPP), the MeasOffset is expressed in terms of timeslots, which are equal to 2560 chips each.  For cdma2000, the MeasOffset is expressed in terms of Power Control Groups (PCGs), which are equal to 1536 chips each. For WLAN-OFDM the MeasOffset is expressed in terms of an integer number of symbol times.  For WLAN-DSSS/CCK/PBCC, the MeasOffset is expressed in terms of chips.

For W-CDMA and cdma2000 the minimum valid MeasOffset is zero, the maximum is equal to the current ResultLength minus one timeslot.  The value is an integer - no fractional timeslots can be specified.  The sum of MeasOffset plus MeasInterval must always be less than or equal to the ResultLength.

The default MeasOffset value for DigDemod3G and WLAN is zero.

See Also

MeasInterval

Meas Setup->Demod Properties. . . ->Time tab


MirrorFreq Property

(Vector only)

Get/set if demod will mirror the frequency spectrum.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodOFDM.MirrorFreq
objDigDemodOFDM.MirrorFreq = blnVal

Remarks

Determine whether the digital demodulation measurement will mirror the measurement data around the center frequency.

Note

If you are demodulating a VSB signal that uses a high-side pilot, you must configure the analyzer to demodulate the high-side pilot by selecting mirror frequency spectrum. If you don't do this, the analyzer cannot find the pilot signal and cannot lock to your signal.

Note

Turning on Frequency.MirrorFreq will again mirror the frequency spectrum.  If you turn on both DigDemod.MirrorFreq and Frequency.MirrorFreq, the effect on digital demodulation is the same as if neither of the properties was set to True.

Note

The frequency error in the symbol table is not inverted by turning on the demod mirror frequency.

See Also

Mirror Frequency Spectrum

Mirror Frequency

Setting up a Digital Demodulation Measurement


Normalize Property

(Vector only)

Get/set if demod will normalize the magnitude of the IQ data to the ideal state positions. Also controls normalization of the error vector.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodOFDM.Normalize
objDigDemodOFDM.Normalize = blnVal

Remarks

This property controls the normalization of the IQ data to the ideal state positions.

See Also

For details about normalization, see  Normalization Overview.

For more information about digital demodulation, see Setting up a Digital Demodulation Measurement

Meas Setup->Demod Properties. . . ->Advanced tab


PilotTrackAmpl Property

(Vector only)

Get/sets whether pilot amplitude tracking is enabled.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodOFDM.PilotTrackAmpl
objDigDemodOFDM.PilotTrackAmpl = blnVal

Remarks

The 802.11a standard only specifies pilot phase tracking (which the analyzer normally does). This option allows you to turn on amplitude tracking in addition to the normal phase tracking.

See Also

Meas Setup->Demod Properties. . . ->Advanced tab


PilotTrackPhase Property

(Vector only)

Get/sets whether pilot phase tracking is enabled.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodOFDM.PilotTrackPhase
objDigDemodOFDM.PilotTrackPhase = blnVal

Remarks

The 802.11a and HIPERLAN/2 standards require pilot phase tracking. Disabling pilot phase tracking can be useful for debugging purposes. When enabled, the average phase error of the four pilot sub-carriers at each symbol time is averaged together, and the resulting phase is removed from all subcarriers (pilot and data) for that symbol time. The default value is True.

See Also

Meas Setup->Demod Properties. . . ->Advanced tab


PilotTrackTiming Property

(Vector only)

Gets/sets whether pilot timing tracking is enabled.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodOFDM.PilotTrackTiming
objDigDemodOFDM.PilotTrackTiming = blnVal

Remarks

The 802.11a standard only specifies pilot phase tracking (which the analyzer normally does). This option allows you to turn on timing tracking in addition to the normal phase tracking. The default value is False.

See Also

Meas Setup->Demod Properties. . . ->Advanced tab


ResultLen Property

(Vector only)

Gets/sets the result length to use expressed as an integer number of symbol times.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodOFDM.ResultLen
objDigDemodOFDM.ResultLen = lngVal

Remarks

For DigDemodOFDM ResultLenType must be set to vsaOFDMResultLenTypeManual for this to have any effect. This ResultLen is used as the number of symbols to demodulate, ignoring whatever burst length is encoded in the SIGNAL symbol.

Also See

MaxResultLen Property

ResultLenType

Meas Setup->Demod Properties. . . ->Time tab


ResultLenType Property

(Vector only)

Gets/sets whether to automatically determine the result length, or to specify it explicitly using the ResultLen property.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaOFDMResultLenType
enumVal = objDigDemodOFDM.ResultLenType
objDigDemodOFDM.ResultLenType = enumVal

Remarks

If ResultLenType is set to vsaOFDMResultLenTypeManual, then the ResultLen property is used. Otherwise, the MaxResultLen property is used to limit the result length.

Also See

MaxResultLen Property

ResultLenType Property

MeasSetup->Demod Properties. . . ->Time tab


SearchLen Property

(Vector only)

Gets/sets the search length in seconds.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemodOFDM.SearchLen
objDigDemodOFDM.SearchLen = dblVal

Remarks

The SearchLenUnit property returns the units of the search length, either second or symbol.  The SetSearchLen method sets both the search length and the unit. The SearchLen is forced to be large enough to hold the maximum result length. The maximum result length is specified by ResultLen if ResultLenType is vsaOFDMResultLenTypeManual, or by MaxResultLen if ResultLenType is vsaOFDMResultLenTypeAuto.  Note that SearchLen is in seconds while the result length is in symbol times.  (One symbol time is (1+GuardInterval)/SubCarrierSpacing seconds.)

See Also

Search Length

Meas Setup->Demod Properties. . . ->Time tab


Standard Property

(Vector only)

Gets/sets the demod standard to apply.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaOFDMStandards
enumVal = objDigDemodOFDM.Standard
objDigDemodOFDM.Standard = enumVal

Remarks

Gets or returns the current standard that is analyzed by the DigDemod3G object or the DigDemodOFDM object. For the DigDemod3G object, the value vsaDigDemSta3GPP means the object will analyze W-CDMA (3GPP) signals, and the value vsaDigDemStaCdma2000 means the object will analyze cdma2000 signals. For DigDemodOFDM, vsaOFDMSta80211a, vsaOFDMStaHIPERLAN2, and vsaOFDMSta80211gCCKOFDM indicate the available standards that will be analyzed. Typically this is the first property that is set in a DigDemod3G or DigDemodOFDM object, because this property fundamentally affects many of the other properties.  For example, many of the minimum and maximum values for properties are different for cdma2000 than they are for W-CDMA.

See Also

MeasSetup->Demod Properties. . . ->Format tab


SubCarrierModFormat Property

(Vector only)

Gets/sets the subcarrier modulation format.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaOFDMSubCarrierFormat
enumVal = objDigDemodOFDM.SubCarrierModFormat
objDigDemodOFDM.SubCarrierModFormat = enumVal

Remarks

SubCarrierModType must be set to vsaOFDMSubCarrierModTypeManual for this to have any effect.  The SubCarrierModFormat is the format assumed for the data subcarriers in the OFDM signal.  The pilot subcarriers are always assumed to be BPSK.

See Also

SubCarrierModType Property

MeasSetup->Demod Properties. . . ->Format tab


SubCarrierModType Property

(Vector only)

Gets/sets whether the subcarrier modulation format is determined automatically or set explicitly using the SubCarrierModFormat property.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaOFDMSubCarrierModType
enumVal = objDigDemodOFDM.SubCarrierModType
objDigDemodOFDM.SubCarrierModType = enumVal

Remarks

SubCarrierModType must be set to vsaOFDMSubCarrierModTypeManual for SubCarrierModFormat to have any effect.

See Also

SubCarrierModFormat Property

MeasSetup->Demod Properties. . . ->Format tab


SubCarrierNum Property

(Vector only)

Gets/sets which subcarrier to analyze (meaningful only if looking at a single subcarrier - specified using SubCarrierSet property).

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodOFDM.SubCarrierNum
objDigDemodOFDM.SubCarrierNum = lngVal

Remarks

SubCarrierSet property must be set to vsaOFDMSubCarrierSetOneChan for SubCarrierNum to have any effect.  The subcarriers are numbered from –26 to +26.  Subcarrier number zero is unused.

See Also

SubCarrierSet Property

MeasSetup->Demod Properties. . . ->Advanced tab


SubCarrierSet Property

(Vector only)

Gets/sets whether to look at all subcarriers, just a single subcarrier (specified with SubCarrierNum property), or just pilot subcarriers.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaOFDMSubCarrierSet
enumVal = objDigDemodOFDM.SubCarrierSet
objDigDemodOFDM.SubCarrierSet = enumVal

Remarks

The enums for this property are defined as follows:

•	vsaOFDMSubCarrierSetAll uses all subcarriers.

•	vsaOFDMSubCarrierSetOneChan uses the single subcarrier specified by SubCarrierNum.

•	vsaOFDMSubCarrierSetPilots uses only the four pilot subcarriers.

See Also

SubCarrierNum Property

MeasSetup->Demod Properties. . . ->Advanced tab


SubCarrierSpacing Property

(Vector only)

Gets/sets subcarrier spacing in Hz.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemodOFDM.SubCarrierSpacing
objDigDemodOFDM.SubCarrierSpacing = dblVal

Remarks

The default value is 312.5 kHz.

See Also

MeasSetup->Demod Properties. . . ->Advanced tab


SymbolTimeAdjust Property

(Vector only)

Gets/sets the IFFT offset within the symbol time expressed as a percentage of the IFFT time length.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemodOFDM.SymbolTimeAdjust
objDigDemodOFDM.SymbolTimeAdjust = dblVal

Remarks

A value of zero means the FFT is at the end of the symbol time.  The SymbolTimeAdjust value is negative (or zero), and can have a maximum negative value as shown in the following calculation:
–(GuardInterval)x100, shown as a percentage.

See Also

MeasSetup->Demod Properties. . . ->Advanced tab


SyncType Property

(Vector only)

Gets/sets which part of the preamble is used for synchronization.

Applies To:	DigDemodOFDM Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaOFDMSyncType
enumVal = objDigDemodOFDM.SyncType
objDigDemodOFDM.SyncType = enumVal

Remarks

This property is used in W-CDMA (3GPP) and OFDM measurements.  This property specifies the synchronization method to be used when demodulating the signal.

The valid sync types for 3GPP are vsaDigDemod3GppSyncTypeCPICH and vsaDigDemod3GppSyncTypeSCH.  Most W-CDMA signals have a CPICH channel, so vsaDigDemod3GppSyncTypeCPICH is generally the best synchronization type to use.  Some W-CDMA signals don't have a CPICH channel, so for those signals you must use the vsaDigDemod3GppSyncTypeSCH.  If neither CPICH nor SCH channels are present in the signal, the analyzer will not be able to demodulate the signal.

The default value for 3GPP is vsaDigDemod3GppSyncTypeCPICH.

The valid sync types for OFDM are vsaOFDMSyncTypeShort and vsaOFDMSyncTypeChanEst (“ChanEst” stands for channel estimation, which is also called the “long sync” type). These are different methods of synchronizing to the start of an OFDM burst. The vsaOFDMSyncShortType method synchronizes to the ”short sync” part of the preamble. The vsaOFDMSyncChanEst method synchronizes to the “channel estimation” part of the preamble. Either sync type is valid for 802.11a. Only vsaOFDMSyncTypeChanEst is valid for HIPERLAN/2 and 802.11gCCKOFDM, because these signas do not always contain a short sync in the preamble.

The default value for OFDM is the “short type”, vsaOFDMSyncTypeShort.

See Also

Sync Search

Search Tab

SyncType Property

Meas Setup->Demod Properties. . . ->Advanced tab


SetDefault Method

(Vector only)

Preset all measurement attributes to default values for indicated standard.

Applies To:	DigDemodOFDM Object

Syntax:	objDigDemodOFDM.SetDefault(newval)

Parameter	Data Type	Default Value	Description
newval	VsaOFDMStandards	None	Sets the direction.  See the VsaDigDemod3GDirectionenum_VsaDigDemod3GDirection enumeration for valid values.
Remarks

This method resets all properties to default values appropriate for the current Standard.  In addition, the frequency span of the analyzer is set to a default value appropriate for the current Standard.

See Also

Standard Property

Meas Setup->Demod Properties. . . ->Format tab


DigDemodTDSCDMA Object

(Vector only)

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
ActiveSlotThreshold †	RW	Gets/sets the threshold for detecting an active timeslot relative to the power of the highest amplitude timeslot (in dBc).
AnalysisSubframes †	RW	Gets/sets which subframes are used for analysis.
AnalysisTimeslots †	RW	Gets/sets the analysis timeslots.
BasicMidambleCode †	RW	Gets/sets the Basic Midamble Code. Only applicable if BasicMidambleCodeAuto is false.
BasicMidambleCodeGroup †	RW	Gets/sets whether the Basic Midamble Code is restricted to the code group determined by DownlinkPilotCode.
CDLSpreadCodeLength †	RW	Gets/sets the CDL Spread Code length.
ChipRate †	RW	Gets/sets the chip rate.
CodeChannel †	RW	Gets/sets the code channel.
DownlinkPilotCode †	RW	Gets/sets the downlink pilot code.
FilterAlpha †	RW	Gets/sets the filter alpha.
K †	RW	Gets/sets the maximum users (K) for the indicated timeslot.
MirrorFreq †	RW	Get/set if demod will mirror the frequency spectrum.
Normalize †	RW	Get/set if demod will normalize the magnitude of the IQ data.
ResultLen †	RW	Gets/sets the result length.
ScrambleCode †	RW	Gets/sets the scramble code.
ScrambleCodeGroup †	RW	Gets/sets whether the scramble code is restricted to the code group specified by DownlinkPilotCode.
SpreadCodeLength †	RW	Gets/sets the spread code length.
StartBoundary †	RW	Gets/sets the start boundary.
TimeReference †	RW	Gets/sets the time reference.
UplinkPilotCode †	RW	Gets/sets the uplink pilot code.
UplinkPilotCodeGroup †	RW	Gets/sets whether the uplink pilot code is restricted to the code group specified by DownlinkPilotCode.
Methods	Description
SetDefault †	Resets all demod properties to defaults for the indicated standard.
Remarks

To learn how this feature works, see online help for the dialog box that lets you access this object.


ActiveSlotThreshold Property

(Vector only)

Gets/sets the threshold for detecting an active timeslot relative to the power of the highest amplitude timeslot (in dBc).

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemodTDSCDMA.ActiveSlotThreshold
objDigDemodTDSCDMA.ActiveSlotThreshold = dblVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


AnalysisSubframes Property

(Vector only)

Gets/sets which subframes are used for analysis.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim varVal As Variant
varVal = objDigDemodTDSCDMA.AnalysisSubframes
objDigDemodTDSCDMA.AnalysisSubframes = varVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter

Note that this property can only get/set a single subframe for analysis; the first subframe is numbered zero (0).


AnalysisTimeslots Property

(Vector only)

Gets/sets the analysis timeslots.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemodTDSTimeSlots
enumVal = objDigDemodTDSCDMA.AnalysisTimeslots
objDigDemodTDSCDMA.AnalysisTimeslots = enumVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.

Note that this property can only get/set a single timeslot for analysis; the first timeslot is numbered zero (0).


BasicMidambleCode Property

(Vector only)

Gets/sets the Basic Midamble Code. Only applicable if BasicMidambleCodeAuto is false.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodTDSCDMA.BasicMidambleCode
objDigDemodTDSCDMA.BasicMidambleCode = lngVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


BasicMidambleCodeGroup Property

(Vector only)

Gets/sets whether the Basic Midamble Code is restricted to the code group determined by DownlinkPilotCode.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodTDSCDMA.BasicMidambleCodeGroup
objDigDemodTDSCDMA.BasicMidambleCodeGroup = blnVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


CDLSpreadCodeLength Property

(Vector only)

Gets/sets the CDL Spread Code length.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodTDSCDMA.CDLSpreadCodeLength
objDigDemodTDSCDMA.CDLSpreadCodeLength = lngVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


ChipRate Property

(Vector only)

Gets/sets the chip rate.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemodTDSCDMA.ChipRate
objDigDemodTDSCDMA.ChipRate = dblVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


CodeChannel Property

(Vector only)

Gets/sets the code channel.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodTDSCDMA.CodeChannel
objDigDemodTDSCDMA.CodeChannel = lngVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


DownlinkPilotCode Property

(Vector only)

Gets/sets the downlink pilot code.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodTDSCDMA.DownlinkPilotCode
objDigDemodTDSCDMA.DownlinkPilotCode = lngVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


FilterAlpha Property

(Vector only)

Gets/sets the filter alpha.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objDigDemodTDSCDMA.FilterAlpha
objDigDemodTDSCDMA.FilterAlpha = dblVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


K Property

(Vector only)

Gets/sets the maximum users (K) for the indicated timeslot.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodTDSCDMA.K(timeSlot)
objDigDemodTDSCDMA.K(timeSlot) = lngVal

Parameter	Data Type	Default Value	Description
timeSlot	Long	None	Determines which timeslot is used.  Timeslots begin with the number zero (0).
Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


MirrorFreq Property

(Vector only)

Get/set if demod will mirror the frequency spectrum.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodTDSCDMA.MirrorFreq
objDigDemodTDSCDMA.MirrorFreq = blnVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


Normalize Property

(Vector only)

Get/set if demod will normalize the magnitude of the IQ data.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodTDSCDMA.Normalize
objDigDemodTDSCDMA.Normalize = blnVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


ResultLen Property

(Vector only)

Gets/sets the result length.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodTDSCDMA.ResultLen
objDigDemodTDSCDMA.ResultLen = lngVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.

Note that the units for this property are subframes.


ScrambleCode Property

(Vector only)

Gets/sets the scramble code.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodTDSCDMA.ScrambleCode
objDigDemodTDSCDMA.ScrambleCode = lngVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


ScrambleCodeGroup Property

(Vector only)

Gets/sets whether the scramble code is restricted to the code group specified by DownlinkPilotCode.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodTDSCDMA.ScrambleCodeGroup
objDigDemodTDSCDMA.ScrambleCodeGroup = blnVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


SpreadCodeLength Property

(Vector only)

Gets/sets the spread code length.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodTDSCDMA.SpreadCodeLength
objDigDemodTDSCDMA.SpreadCodeLength = lngVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


StartBoundary Property

(Vector only)

Gets/sets the start boundary.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemodTDSStart
enumVal = objDigDemodTDSCDMA.StartBoundary
objDigDemodTDSCDMA.StartBoundary = enumVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


TimeReference Property

(Vector only)

Gets/sets the time reference.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaDigDemodTDSTimeRef
enumVal = objDigDemodTDSCDMA.TimeReference
objDigDemodTDSCDMA.TimeReference = enumVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


UplinkPilotCode Property

(Vector only)

Gets/sets the uplink pilot code.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDigDemodTDSCDMA.UplinkPilotCode
objDigDemodTDSCDMA.UplinkPilotCode = lngVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


UplinkPilotCodeGroup Property

(Vector only)

Gets/sets whether the uplink pilot code is restricted to the code group specified by DownlinkPilotCode.

Applies To:	DigDemodTDSCDMA Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDigDemodTDSCDMA.UplinkPilotCodeGroup
objDigDemodTDSCDMA.UplinkPilotCodeGroup = blnVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


SetDefault Method

(Vector only)

Resets all demod properties to defaults for the indicated standard.

Applies To:	DigDemodTDSCDMA Object

Syntax:	objDigDemodTDSCDMA.SetDefault

Remarks

To learn how this feature works, see online help for the dialog box that lets you execute this function.


Display Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Color	RW	Get/set the colors for areas of the display.
ColorCount	R	Returns the number of colors used by the Color property.
Font	-->	Returns the font objects for areas of the display.
IsColorByTrace	R	Returns true if this Color index can be different for each trace.
MapUserColor	RW	Get/set the specified color in the spectrogram user color map.
MapUserColorCount	RW	Get/set the number of colors in the spectrogram user color map.
MapUserColorData	R	Get all the colors in the spectrogram user color map in the specified numeric format.
MapUserColorMaxCount	R	Get the maximum number of colors in the spectrogram user color map.
MenuVisible	RW	Get/set if the main display menu is visible.
StatusVisible	RW	Get/set if the main display status line is visible.
Traces	-->	Returns the Traces object.
Methods	Description
Default	Default the display settings.
DefaultMapUserColor	Default the spectrogram user color map colors.
MapUserColorDataSet	Set all the colors in the spectrogram user color map.
RecallFile	Recall the display attributes from a file.
RecallMapUserColorFile	Recall the spectrogram user color map colors from a file.
SaveFile	Save the display attributes to a file.
SaveMapUserColorFile	Save the spectrogram user color map colors to a file.
Remarks

The Display object represents the analyzer's display.  It provides access to display-wide properties such as display colors and fonts.  It also provides access to the Traces object, a collection that represents the 4 traces on the display.

The top-level display attributes are not stored with the measurement state, but are stored as display appearance with the Display.SaveFile method.

See Also

Saving and Recalling Display Appearance

Preset Display Appearance


Color Property

Get/set the colors for areas of the display.

Applies To:	Display Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDisplay.Color(iInx, iTrc)
objDisplay.Color(iInx, iTrc) = lngVal

Parameter	Data Type	Default Value	Description
iInx	VsaColorIndex	None	An index representing the display feature.
iTrc	Integer	None	Identifies which trace (1 through 4).
Remarks

The Color property determines the color of a trace element.  The Color Index enumeration contains constants that identify the display feature whose color you wish to determine or change.  The ColorCount property returns the number of color indexes available.

Your program can read another related property, IsColorByTrace, to determine whether the color changes for other features are settable trace-by-trace, or if the color of that feature will change on all traces when its color is changed on any one trace.  Besides the trace itself, markers and symbols can be set trace-by-trace. All other display features are global. For example, changing the color of Trace A's grid changes the color of all the grids.

The color is an RGB color Value.  In VB, you can use the RGB() function to generate colors. For example, RGB (255,0,0) is red, RGB (0,0,0) is black, and RGB (255,255,255) is white.

See Also

Color Tab

ColorCount Property

IsColorByTrace Property


ColorCount Property

Returns the number of colors used by the Color property.

Applies To:	Display Object

Access:	Read only

Syntax:	Dim intVal As Integer
intVal = objDisplay.ColorCount

Remarks

The ColorCount property returns the number of color indexes available to the Color property and the IsColorByTrace property.  Each color index identifies a displayed portion of the trace.

See Also

Color Tab

IsColorByTrace Property


Font Property

Returns the font objects for areas of the display.

Applies To:	Display Object

Syntax:	Dim objFont As Font
Set objFont = objDisplay.Font(inxFont)

Parameter	Data Type	Default Value	Description
inxFont	VsaFontIndex	None	The display field index.
Remarks

Returns the Font object for this display field. You can set the font of the text annotation around the traces and the measurement status line at the bottom of the main application window.  The font object has the following properties which you use to modify the font's appearance:

•	Bold - The font is displayed with bold attribute.

•	Charset - The character set of the font (0 is ANSI character set).

•	Italic - The font is displayed with italic attribute.

•	Name - The name of the font.

•	Size - The size of the font, in points.

•	Strikethrough- The font is displayed with strikethrough attribute.

•	Underline- The font is displayed with underline attribute.

•	Weight - The weight of the font (0 is don't care, 100 is thin, 400 is normal, 700 is bold).

See Also

Font Tab


IsColorByTrace Property

Returns true if this Color index can be different for each trace.

Applies To:	Display Object

Access:	Read only

Syntax:	Dim blnVal As Boolean
blnVal = objDisplay.IsColorByTrace(iInx)

Parameter	Data Type	Default Value	Description
iInx	VsaColorIndex	None	A constant that specifies the color area of the display.
Remarks

Returns whether the specified display feature can have a different color for each trace.  This is useful for code which iterates through the Color property (using ColorCount) to get the colors for the display features.  The trace data, markers, and symbols can have different colors for each trace.  All other display features do not have trace-by-trace colors.

See Also

Color Tab

ColorCount Property

Color Property


MapUserColor Property

Get/set the specified color in the spectrogram user color map.

Applies To:	Display Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objDisplay.MapUserColor(iInx)
objDisplay.MapUserColor(iInx) = lngVal

Parameter	Data Type	Default Value	Description
iInx	Integer	None	Integer between 1 and Display.MapUserColorCount that selects a color from a spectrogram user color map.
Remarks

This property sets or gets a single RGB color in the spectrogram user color map.  The first color (iInx=1) is associated with the minimum scale value.  If you are going to set all the colors in the user color map, it is more efficient to use Display.MapUserColorDataSet.

See Also

MapUserColorCount Property

MapColorData Property

MapUserColorData Property

MapUserColorDataSet Method

MapUserColorMaxCount Property


MapUserColorCount Property

Get/set the number of colors in the spectrogram user color map.

Applies To:	Display Object

Access:	Read/Write

Syntax:	Dim intVal As Integer
intVal = objDisplay.MapUserColorCount
objDisplay.MapUserColorCount = intVal

Remarks

This property sets or gets the number of colors in the spectrogram user color map.  The count must be between 0 and Display.MapUserColorMaxCount.

See Also

Color Count

User Map Color Tab

MapColorData Property

MapUserColor Property

MapUserColorData Property

MapUserColorDataSet Method

MapUserColorMaxCount Property


MapUserColorData Property

Get all the colors in the spectrogram user color map in the specified numeric format.

Applies To:	Display Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objDisplay.MapUserColorData(vType)

Parameter	Data Type	Default Value	Description
vType	Integer	None	Data type of the elements of the returned array, which can be vbLong (3), vbSingle (4), vbDouble (5), or vbVariant (12).
Remarks

This property returns an array that contains all the RGB colors in the spectrogram user color map.  Use vType to specify the data type of the elements of the returned array

See Also

Color Count

User Map Color Tab

MapColorData Property

MapUserColor Property

MapUserColorDataSet Method

MapUserColorMaxCount Property


MapUserColorMaxCount Property

Get the maximum number of colors in the spectrogram user color map.

Applies To:	Display Object

Access:	Read only

Syntax:	Dim intVal As Integer
intVal = objDisplay.MapUserColorMaxCount

Remarks

This property returns the maximum number of colors (64) in the spectrogram user color map.

See Also

Color Count

MapColorData Property


MenuVisible Property

Get/set if the main display menu is visible.

Applies To:	Display Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDisplay.MenuVisible
objDisplay.MenuVisible = blnVal

Remarks

Determine whether the application's menu is Visible.

See Also

Window Tab (Display Appearance)


StatusVisible Property

Get/set if the main display status line is visible.

Applies To:	Display Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objDisplay.StatusVisible
objDisplay.StatusVisible = blnVal

Remarks

Determine whether the application's measurement status line is Visible.  The measurement status line is the bar that contains text at the bottom of the main application window.

Among other things, status messages that appear in this area indicate whether a measurement is running or not.

See Also

Show Status


Traces Property

Returns the Traces object.

Applies To:	Display Object

Syntax:	Dim objTraces As Traces
Set objTraces = objDisplay.Traces

Remarks

Traces (a property of the Display object) returns a Traces object.

See Also

Traces Object


Default Method

Default the display settings.

Applies To:	Display Object

Syntax:	objDisplay.Default

Remarks

Sets the display appearance to its default Values.  This is the same as clicking File, Preset, Preset Display Appearance from the application's main menu.

See Also

Preset All

Preset Display Appearance


DefaultMapUserColor Method

Default the spectrogram user color map colors.

Applies To:	Display Object

Syntax:	objDisplay.DefaultMapUserColor

Remarks

Loads the spectrogram user color map with default colors.

See Also

RecallMapUserColorFile

Preset User Color Map


MapUserColorDataSet Method

Set all the colors in the spectrogram user color map.

Applies To:	Display Object

Syntax:	objDisplay.MapUserColorDataSet(vRgbArr)

Parameter	Data Type	Default Value	Description
vRgbArr	Variant	None	A variant array that contains RGB colors for a user color map.
Remarks

This property sets all the colors in the spectrogram user color map from a specified RGB color array.

See Also

MapUserColorData Property


RecallFile Method

Recall the display attributes from a file.

Applies To:	Display Object

Syntax:	objDisplay.RecallFile(sFileName)

Parameter	Data Type	Default Value	Description
sFileName	String	None	The name of the file to recall.
Remarks

Recalls the display appearance from the specified file.

See Also

Recall Display Appearance


RecallMapUserColorFile Method

Recall the spectrogram user color map colors from a file.

Applies To:	Display Object

Syntax:	objDisplay.RecallMapUserColorFile(sFileName)

Parameter	Data Type	Default Value	Description
sFileName	String	None	The name of the file that contains the user color map.
Remarks

Loads the spectrogram user color map from the specified file.  The file format is the same as the E3238S user color map file.

See Also

SaveMapUserColorFile

Recall User Color Map


SaveFile Method

Save the display attributes to a file.

Applies To:	Display Object

Syntax:	objDisplay.SaveFile(sFileName)

Parameter	Data Type	Default Value	Description
sFileName	String	None	The name of the file to save to.
Remarks

Note that this method always saves trace and recording header information (which is optional when running the application manually). This means that if you wish to load the saved trace or recording into some other application, such as a database or some other signal analysis application, you will need to strip out the header information using a text editor.

Saves the display appearance to the specified file.

See Also

Recall Trace

Recall Display Appearance

Recall Setup

Recall Recording


SaveMapUserColorFile Method

Save the spectrogram user color map colors to a file.

Applies To:	Display Object

Syntax:	objDisplay.SaveMapUserColorFile(sFileName)

Parameter	Data Type	Default Value	Description
sFileName	String	None	The filename where you want to save the user color map colors.
Remarks

Saves the spectrogram user color map to the specified file.

See Also

RecallMapUserColorFile

SaveUserColorMap


Frequency Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Band	RW	Get/set the current frequency band index.
BandCount	R	Get the number of frequency bands supported by the current hardware.
BandStart	R	Returns the start frequency of the specified frequency band.
BandStop	R	Returns the stop frequency of the specified frequency band.
Center	RW	Get/set the measurement center frequency.
GateWindow †	RW	Get/set the window applied to the gated time data.
GateWindowIsMain †	RW	Get/set if the gate window is the same as the main window.
MirrorFreq †	RW	Get/set whether the measurement data is mirrored around the center frequency.
Points	RW	Get/set the number of unaliased frequency points to display.
PointsIsDisplay ‡	RW	Get/set if Points is the same as the # of pixels in the displayed spectrum.
ResBW	RW	Get/set the resolution bandwidth (RBW).
ResBWArbitrary	RW	Get/set what values you may enter for RBW.
ResBWCouple	RW	Get/set how RBW is coupled to the frequency span.
SignalTrack	RW	Get/set whether the center frequency will track a signal.
SignalTrackChannel	RW	Get/set which input channel that SignalTrack will track.
Span	RW	Get/set the measurement frequency span.
StartFreq	RW	Get/set the measurement start frequency.
Step	RW	Get/set the frequency step for start, center, and stop incremental changes.
StepAuto	RW	Get/set whether the frequency step is fixed or automatically determined.
StopFreq	RW	Get/set the measurement stop frequency.
Window	RW	Get/set the window applied to the main time data.
Zoom †	RW	Get/set whether the measurement is zoomed or baseband
Methods	Description
DefaultSpan	Sets the Span to its default value (largest span).
FromSpecAnalyzer †	Set the measurement frequency to match that of a running Spectrum Analyzer application.
MirrorAroundCenter †	If MirrorFreq is True, mirrors the supplied value about the center frequency. Otherwise supplied value is returned.
PointsNearest †	Return the nearest valid Points value.
RecordingCenterSpan †	Set the frequency to be the same as the current recording.
ResBWNearest	Returns the nearest 1-3-10 step RBW if not ResBWArbitrary.
SetCenterSpan	Set the measurement center frequency and span.
SetStartStop	Set the measurement start and stop frequency.
SetStartStopRbw ‡	Set the measurement start, stop frequencies and the RBW.
Remarks

The Frequency object represents the frequency settings of a measurement, including the center, span, zoom, resolution bandwidth, and how these parameters are related to each other.  You can also control windowing and whether the measurement will track the dominant signal in the measurement.

Some analyzers support more than one frequency band. For example, the 89640 analyzer has two frequency bands: 0 Hz-37.11 MHz, and 36 MHz-2.7 GHz.  The 89610 analyzer has only one frequency band: 0 Hz-39.06 MHz. Use the BandCount property to determine if multiple bands exist.  Use the BandStart and BandStop properties to determine the frequency range of a band.  Use the Band property to select a frequency band.

Note

Some properties and methods of the Frequency object are unique to the AgtVsaScalar or AgtVsaVector application, as indicated in the Objects Table.

See Also

Frequency Tab

ResBW Tab


Band Property

Get/set the current frequency band index.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim intVal As Integer
intVal = objFrequency.Band
objFrequency.Band = intVal

Remarks

The Frequency object's Band property sets or returns the band as an integer (starting at 1).  The number of available bands depends on the capabilities of the current hardware.

To get a count of the available bands, use the read-only property BandCount.

To find the frequency range of a given band, use the BandStart Property and BandStop Property properties.

The frequency band affects the Valid range of Values for Center, Span and InpChannel.Range.

See Also

Frequency Bands


BandCount Property

Get the number of frequency bands supported by the current hardware.

Applies To:	Frequency Object

Access:	Read only

Syntax:	Dim intVal As Integer
intVal = objFrequency.BandCount

Remarks

The number of available bands depends on the capabilities of the current hardware.

To select a band, use the Band Property. To find the frequency range of a given band, use the BandStart Property and BandStop Property properties.

See Also

Frequency Bands


BandStart Property

Returns the start frequency of the specified frequency band.

Applies To:	Frequency Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objFrequency.BandStart(iBand)

Parameter	Data Type	Default Value	Description
iBand	Integer	None	An integer, starting with 1, which specifies a band number.
Remarks

89600-series analyzers have one or more frequency bands.  This property returns the start frequency of the current frequency band.  The number of available bands depends on the capabilities of the current hardware.

The BandCount property returns how many bands are available.  The Band property returns the current band.

See Also

Frequency Bands


BandStop Property

Returns the stop frequency of the specified frequency band.

Applies To:	Frequency Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objFrequency.BandStop(iBand)

Parameter	Data Type	Default Value	Description
iBand	Integer	None	An integer, starting with 1, which specifies a band number.
Remarks

89600-series analyzers have one or more frequency bands.  This property returns the stop frequency of the current frequency band.  The number of available bands depends on the capabilities of the current hardware.

The BandCount property returns how many bands are available.  The Band property returns the current band.

See Also

Frequency Bands


Center Property

Get/set the measurement center frequency.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objFrequency.Center
objFrequency.Center = dblVal

Remarks

You can set the frequency range with the Center/Span properties or StartFreq/StopFreq properties.  You can also use SetCenterSpan or SetStartStop methods to set the frequency range all at one time.

See Also

Center Frequency


GateWindow Property

(Vector only)

Get/set the window applied to the gated time data.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaFrqWindow
enumVal = objFrequency.GateWindow
objFrequency.GateWindow = enumVal

Remarks

Determine the type of window (Uniform, Hanning, Gaussian Top, or Flat Top) to apply to gated time data.

VsaFrqWindow	Common Usage
vsaFrqWndUniform	Transient and self-windowing data.
vsaFrqWndHanning	General purpose.
vsaFrqWndGauss	High dynamic range.
vsaFrqWndFlatTop	High amplitude accuracy.
If the GateWindowIsMain property is set to True, then GateWindow is ignored.

For an introduction to windowing, refer to Windowing Overview.
For details about the Various types of windows, see Window Types.

See Also

Time Tab (MeasSetup)

GateWindowIsMain Property


GateWindowIsMain Property

(Vector only)

Get/set if the gate window is the same as the main window.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objFrequency.GateWindowIsMain
objFrequency.GateWindowIsMain = blnVal

Remarks

Determine whether the gate window is set to be the same as the main window.  If GateWindowIsMain is set to False, then the time gate window is determined by the GateWIndow property.

For an introduction to windowing concepts, refer to Windowing Overview.
For details about the different types of windows, see Window Types.

See Also

Time Tab (MeasSetup)

GateWindow Property


MirrorFreq Property

(Vector only)

Get/set whether the measurement data is mirrored around the center frequency.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objFrequency.MirrorFreq
objFrequency.MirrorFreq = blnVal

Remarks

Determine whether the measurement will mirror the measurement data around the center frequency.

See Also

Mirror Frequency Spectrum

Mirror Frequency


Points Property

Get/set the number of unaliased frequency points to display.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objFrequency.Points
objFrequency.Points = lngVal

Remarks

Determine the number of unaliased frequency points for the measurement to calculate.

For the VsaVector application, it may be one of the following Values: 51, 101, 201, 401, 801, 1601, 3201, 6401, 12801, 25601, 51201, 102401.

For the VsaScalar application, it may be any Value between 2 and 131072.  It may also be coupled to the number of pixels in the displayed spectrum with the PointsIsDisplay property.

See Also

Frequency Points


PointsIsDisplay Property

(Scalar only)

Get/set if Points is the same as the # of pixels in the displayed spectrum.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objFrequency.PointsIsDisplay
objFrequency.PointsIsDisplay = blnVal

Remarks

This property is only available in the Spectrum Analyzer application.  If PointsIsDisplay is True, then the value of the Frequency.Points property is determined by the width of a trace in the main application window.  The actual value of Points is affected by the size of the application window, the resolution of the display, the Layout of the traces, and the size of the trace annotation font.

See Also

Frequency Points topic - Same as display checkbox


ResBW Property

Get/set the resolution bandwidth (RBW).

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objFrequency.ResBW
objFrequency.ResBW = dblVal

Remarks

Determine the resolution bandwidth, in Hertz, of the measurement.

Note that in digital demodulation, resolution bandwidth is determined automatically and can not be set independently.  In all measurements, resolution bandwidth is related to the time-record length and the selected window type.  Details about these dependencies can be found in the topic How Resolution Bandwidth Interacts with Other Parameters.

See Also

ResBW

ResBWArbitrary Property

ResBWCouple Property

ResBWNearest Method


ResBWArbitrary Property

Get/set what values you may enter for RBW.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objFrequency.ResBWArbitrary
objFrequency.ResBWArbitrary = blnVal

Remarks

Determine whether the Resolution bandwidth is arbitrary or fixed.

The Agilent 89600 series analyzers offer two levels of flexibility in selecting a resolution bandwidth setting: Fixed at 1-3-10 and arbitrary.  The fixed 1-3-10 selection, is the more restrictive.  In this mode the analyzer always sets the resolution bandwidth at a 1 X 10x or 3 X 10x Value.   In this mode the analyzer emulates many existing spectrum analyzers.   The arbitrary mode allows arbitrary setting of resolution bandwidth.

More information can be found in the following topics:

Resolution Bandwidth Coupling and Mode Selections
How Resolution Bandwidth Interacts with Other Parameters
Determining the Minimum and Maximum Resolution Bandwidth


ResBWCouple Property

Get/set how RBW is coupled to the frequency span.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaFrqRbwCouple
enumVal = objFrequency.ResBWCouple
objFrequency.ResBWCouple = enumVal

Remarks

Determine the type of coupling for resolution bandwidth as either auto, offset, or fixed.

Your resolution bandwidth and coupling choices affect both resolution and measurement speed.  To get the best resolution to speed tradeoff, choose auto RBW coupling and arbitrary RBW mode (ResBwArbitrary property).  For the VsaScalar application, these settings affect resolution, but do not affect measurement speed.

More details can be found in the following topics:

Resolution Bandwidth Coupling and Mode Selections
How Resolution Bandwidth Interacts with Other Parameters
Determining the Minimum and Maximum Resolution Bandwidth

See Also

ResBW Couple


SignalTrack Property

Get/set whether the center frequency will track a signal.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objFrequency.SignalTrack
objFrequency.SignalTrack = blnVal

Remarks

The analyzer can change its center frequency automatically to track an input channel's drifting signal.  The SignalTrack property enables and disables this feature.  The SignalTrackChannel property determines the input channel to track.

Signal tracking is not available for the digital demodulation measurement, if averaging is turned on, or for the I+jQ channel configuration

More information about this feature is available in the topic Signal Tracking.

See Also

SignalTrackChannel Property


SignalTrackChannel Property

Get/set which input channel that SignalTrack will track.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim intVal As Integer
intVal = objFrequency.SignalTrackChannel
objFrequency.SignalTrackChannel = intVal

Remarks

Determine which channel is being used for signal tracking.  This is only used if signal track is turned on (SignalTrack set to True).

More information about this feature is available in the topic Signal Tracking.

See Also

Signal Track Channel

SignalTrack Property


Span Property

Get/set the measurement frequency span.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objFrequency.Span
objFrequency.Span = dblVal

Remarks

Determine the frequency span, in Hertz, of the measurement.

The range of allowable spans depends upon the hardware selected for use with the analyzer, whether your input is from hardware or a recording, and whether you are in zoom mode.

The Zoom and Center properties help to more fully describe the analyzer's frequency settings.  The SetCenterSpan method can be used to specify zoom, center, and span all at the same time.

More information can be found in the topic Frequency Span.


StartFreq Property

Get/set the measurement start frequency.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objFrequency.StartFreq
objFrequency.StartFreq = dblVal

Remarks

Determine the measurement's start frequency, in Hertz.  The measurements frequency range can be set using the StartFreq / StopFreq properties or the Center / Span properties.  If the StartFreq is not equal to zero, then the Zoom property is set to True.

More information can be found in the topic Frequency Span..

See Also

Start


Step Property

Get/set the frequency step for start, center, and stop incremental changes.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objFrequency.Step
objFrequency.Step = dblVal

Remarks

Even though you can set the Step property programmatically, you can only use it to step the frequency values through the user interface using the arrow key or mouse wheel.  This property is not used if the StepAuto property is set to True.

See Also

Frequency Step

StepAuto Property


StepAuto Property

Get/set whether the frequency step is fixed or automatically determined.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objFrequency.StepAuto
objFrequency.StepAuto = blnVal

Remarks

If StepAuto is set to False, then the frequency step is determined by the Step property.

If StepAuto is set to True, then:

•	span follows 1-2-5 steps and speed optimized spans

•	center frequency follows (span / 10) steps

•	start frequency follows 1-2-5 steps

See Also

Auto Frequency Step

Step Property


StopFreq Property

Get/set the measurement stop frequency.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objFrequency.StopFreq
objFrequency.StopFreq = dblVal

Remarks

Determine the measurement's stop frequency, in Hertz.  The measurements frequency range can be set using the StartFreq / StopFreq properties or the Center / Span properties.

More information can be found in the topic Frequency Span.

See Also

Stop


Window Property

Get/set the window applied to the main time data.

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaFrqWindow
enumVal = objFrequency.Window
objFrequency.Window = enumVal

Remarks

Determine the setting of the type of window (Uniform, Hanning, Gaussian Top, and Flat Top) to apply to main time data.  For VsaVector, if you have gating enabled and GateWindowIsMain is set to True, then the same window is applied to gate time data.

VsaFrqWindow	Common Usage
vsaFrqWndUniform	Transient and self-windowing data.
vsaFrqWndHanning	General purpose.
vsaFrqWndGauss	High dynamic range.
vsaFrqWndFlatTop	High amplitude accuracy.
For an introduction to windowing, refer to Windowing Overview.
For details about the Various types of windows, see Window Types.

See Also

GateWindowIsMain


Zoom Property

(Vector only)

Get/set whether the measurement is zoomed or baseband

Applies To:	Frequency Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objFrequency.Zoom
objFrequency.Zoom = blnVal

Remarks

Zoom is always True for the VsaScalar application and for the digital demodulation measurement.  The type of input hardware selected can also affect the allowable state of this property.

•	The term "zoom" identifies a measurement that has complex time-domain data.   The analyzer performs "zoomed" measurements using an internal LO (local oscillator).  For Vector measurements, zooming lets you enable or disable the LO when the start frequency is 0 Hertz.

•	The term "baseband" (Zoom is False) identifies a measurement that has real time-domain data.  The default is disabled (baseband), which means that the LO is off.  In this case the input signal is not mixed with the analyzer's LO, and the time-domain data is real.

See Also

Time Data: Baseband and Zoom.


DefaultSpan Method

Sets the Span to its default value (largest span).

Applies To:	Frequency Object

Syntax:	objFrequency.DefaultSpan

Remarks

If the current frequency band can only be zoomed, then the span is changed to its largest Value, but the center frequency is not changed.  If the band can baseband (Zoom is False), then the span is changed to its largest Value and Zoom is set to False.

See Also

Full Span


FromSpecAnalyzer Method

(Vector only)

Set the measurement frequency to match that of a running Spectrum Analyzer application.

Applies To:	Frequency Object

Syntax:	objFrequency.FromSpecAnalyzer

Remarks

This method copies the following input parameters from a running Spectrum Analyzer application.  If no VsaScalar application is running, then an error is raised.

•	Start Frequency

•	Stop Frequency

•	Window

•	Resolution Bandwidth (RBW)

•	Frequency Span.  The span from the VsaScalar application is limited to the largest span supported by the measurement.

See Also

From Spec Analyzer


MirrorAroundCenter Method

(Vector only)

If MirrorFreq is True, mirrors the supplied value about the center frequency. Otherwise supplied value is returned.

Applies To:	Frequency Object

Syntax:	Dim dblVal As Double
dblVal = objFrequency.MirrorAroundCenter(dVal)

Parameter	Data Type	Default Value	Description
dVal	Double	None	Frequency (double) that you want transposed.
Remarks

If MirrorFreq is on (True), you can use this function to determine the mirrored frequency of a frequency that you specify (dVal), as follows:

Returned Value = (2 X center_frequency) − dVal

where: center_frequency is the current center frequency of the analyzer

Note that this function does not change any parameters in the analyzer.


PointsNearest Method

(Vector only)

Return the nearest valid Points value.

Applies To:	Frequency Object

Syntax:	Dim lngVal As Long
lngVal = objFrequency.PointsNearest(NewValue)

Parameter	Data Type	Default Value	Description
NewValue	Long	None	An integer Value specifying the desired number of unaliased frequency points to display.
Remarks

Returns the nearest Valid point Value to that specified in the NewValue parameter.  This method runs automatically if an invalid frequency is requested, or your program can call it explicitly.

The NewValue will be rounded to the next larger of the following Values: 51, 101, 201, 401, 801, 1601, 3201, 6401, 12801, 25601, 51201, 102401.


RecordingCenterSpan Method

(Vector only)

Set the frequency to be the same as the current recording.

Applies To:	Frequency Object

Syntax:	objFrequency.RecordingCenterSpan

Remarks

You can change the span when you play back a recorded input data to a measurement (Inputs.DataFrom is VsaInpsDataFromRecording).  This method changes the center and span to be the same as when the data was recorded.

See Also

Recording Span


ResBWNearest Method

Returns the nearest 1-3-10 step RBW if not ResBWArbitrary.

Applies To:	Frequency Object

Syntax:	Dim dblVal As Double
dblVal = objFrequency.ResBWNearest(dResBw)

Parameter	Data Type	Default Value	Description
dResBw	Double	None
Remarks

Returns the nearest Valid Resolution Bandwidth setting to that specified in the parameter.  If the ResBWArbitrary property is set to False, then the RBW is set to the nearest 1-3-10 step.


SetCenterSpan Method

Set the measurement center frequency and span.

Applies To:	Frequency Object

Syntax:	objFrequency.SetCenterSpan(bZoom, dCenter, dSpan)

Parameter	Data Type	Default Value	Description
bZoom	Boolean	None	A Boolean Value indicating whether to enable Zoom.
dCenter	Double	None	Double precision number specifying a center frequency.
dSpan	Double	None	Double precision number specifying a frequency span.
Remarks

This method sets the measurement's center frequency, span, and zoom all at one time.


SetStartStop Method

Set the measurement start and stop frequency.

Applies To:	Frequency Object

Syntax:	objFrequency.SetStartStop(bZoom, dStart, dStop)

Parameter	Data Type	Default Value	Description
bZoom	Boolean	None	A Boolean Value indicating whether to enable Zoom.
dStart	Double	None	Double precision number indicating a start frequency.
dStop	Double	None	Double precision number indicating a stop frequency.
Remarks

This method sets the measurement's start and stop frequencies, and zoom all at one time.


SetStartStopRbw Method

(Scalar only)

Set the measurement start, stop frequencies and the RBW.

Applies To:	Frequency Object

Syntax:	objFrequency.SetStartStopRbw(dStart, dStop, dRbw)

Parameter	Data Type	Default Value	Description
dStart	Double	None	Double precision number indicating a start frequency.
dStop	Double	None	Double precision number indicating a stop frequency.
dRbw	Double	None	Double precision number indicating resolution bandwidth (RBW).
Remarks

This method sets the measurement's start and stop frequencies, and Resolution bandwidth at one time.  This method is only available in the Spectrum Analyzer application.

See Also

Frequency Tab Topic

Resolution Bandwidth Tab Topic


Hardware Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Address	R	Returns the current address for the specified hardware.
DefaultAddress	R	Returns the default address for the specified hardware.
DriverRev	R	Get the driver revision for the specified hardware.
EnableRefLock	RW	Get/set whether the module is locked to the reference.
ExtRefFreq	RW	Gets/sets the external reference frequency for the external reference master (valid only if ExtRefMaster is true).
ExtRefMaster	RW	Gets/sets whether this module is the external reference master.
FirmwareRev	R	Get the firmware revision for the specified hardware.
Model	R	Get the hardware model for the specified hardware.
Parameter	RW	Get/set the named parameter for the specified hardware.
ParameterNames	R	Get the list of valid parameter names for the specified hardware.
SaveAddresses	RW	Get/set if addresses are saved when SetAddresses is called.
SavedAddress	R	Returns the last saved address for the specified hardware.
SelectDefault	RW	Get/set if the default addresses are selected.
SerialNumber	R	Get the serial number for the specified hardware.
Simulate	R	Gets whether the current hardware is being simulated.
Methods	Description
SetAddresses	Set the addresses for the current ADC(s), down converter, and input module.
SetAddressesEx †	Set the addresses for the current ADC(s), down converter, input module and source.
SetAddressesMultiChan	Set the addresses for the current ADC(s), down converter(s), input module(s) and source.
Remarks

The Hardware object represents the hardware pieces that are available for use with the application.  The hardware pieces (ADCs, Down Converter, and Input Module) may represent actual VXI modules, simulated VXI modules, or software interfaces to other applications.

The Hardware object retrieves information about actual VXI modules from the VXI resource manager's table and displays the addresses of the installed hardware devices that the application supports. This information makes it possible to change the instrument configuration programmatically, if the connected VXI mainframe contains a Variety of suitable boards.

Note

The resource table is read-only, and is generated by the hardware during power up.  You can use the Hardware object to select which addresses to include in Various configurations, but not to change the addresses or instrument names.  You must power up the VXI mainframe before starting the application.

Use the Hardware object to select a hardware configuration for each of Input 1, Input 2, Down Converter, and Calibrator.

The hardware selection is saved in an application specific INI file, not in the measurement state.  This allows the same hardware to be used every time you start the application.  Note that VsaScalar and VsaVector do not share hardware selection.

See Also

About Selecting Hardware


Address Property

Returns the current address for the specified hardware.

Applies To:	Hardware Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objHardware.Address(eHw, [iChan])

Parameter	Data Type	Default Value	Description
eHw	VsaHwType	None	The type of hardware as ADC, Converter, or Input.
iChan	Integer	1	The hardware channel.  This is only used for the ADC hardware.
Remarks

The address for simulated hardware starts with "SIM::".  An empty string is returned if no device is set for this type of hardware.

See Also

About Selecting Hardware


DefaultAddress Property

Returns the default address for the specified hardware.

Applies To:	Hardware Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objHardware.DefaultAddress(bSimulate, eHw, [iChan])

Parameter	Data Type	Default Value	Description
bSimulate	Boolean	None	Whether to return a default address for a simulated device
eHw	VsaHwType	None	The type of hardware as ADC, Converter, or Input.
iChan	Integer	1	The hardware channel.  This is only used for the ADC hardware.
Remarks

The address for simulated hardware starts with "SIM::".  An empty string is returned if no device is set for this type of hardware.

See Also

Default Configuration


DriverRev Property

Get the driver revision for the specified hardware.

Applies To:	Hardware Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objHardware.DriverRev(eHw, [iChan])

Parameter	Data Type	Default Value	Description
eHw	VsaHwType	None	The type of hardware as ADC, Converter, or Input.
iChan	Integer	1	The hardware channel.  This is only used for the ADC hardware.
Remarks

An empty string is returned if there is no device for this hardware or you are simulating hardware.

See Also

About Selecting Hardware


EnableRefLock Property

Get/set whether the module is locked to the reference.

Applies To:	Hardware Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objHardware.EnableRefLock(eHw, [iChan])
objHardware.EnableRefLock(eHw, [iChan]) = blnVal

Parameter	Data Type	Default Value	Description
eHw	VsaHwType	None
iChan	Integer	1
Remarks

Controls whether the given module is programmed to lock to an external reference frequency. This property is usually set to True unless the given module is the master module for the system. If the module is the master module, the locking of the whole system to an external reference frequency can be turned on or off.

To determine if the system is currently locked to an external reference, check the vsaStatusBitExtRefLock bit in the Status Object

See Also

ExtRefFreq Property

ExtRefMaster Property

Status Object

Utilities->Reference Frequency

Utilities->Reference Frequency


ExtRefFreq Property

Gets/sets the external reference frequency for the external reference master (valid only if ExtRefMaster is true).

Applies To:	Hardware Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objHardware.ExtRefFreq(eHw, [iChan])
objHardware.ExtRefFreq(eHw, [iChan]) = dblVal

Parameter	Data Type	Default Value	Description
eHw	VsaHwType	None
iChan	Integer	1
Remarks

Some system master modules can lock to a range of external reference frequencies. For those modules, this value specifies the frequency of the external reference signal. Valid only if ExtRefMaster is True.

See Also

EnableRefLock Property

ExtRefMaster Property

Utilities->Reference Frequency


ExtRefMaster Property

Gets/sets whether this module is the external reference master.

Applies To:	Hardware Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objHardware.ExtRefMaster(eHw, [iChan])
objHardware.ExtRefMaster(eHw, [iChan]) = blnVal

Parameter	Data Type	Default Value	Description
eHw	VsaHwType	None
iChan	Integer	1
Remarks

This is the module to which the external reference signal is applied. Regardless of whether an external reference signal is used, this module provides the system reference for all other modules.

See Also

EnableRefLock Property

ExtRefFreq Property

Utilities->Reference Frequency …


FirmwareRev Property

Get the firmware revision for the specified hardware.

Applies To:	Hardware Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objHardware.FirmwareRev(eHw, [iChan])

Parameter	Data Type	Default Value	Description
eHw	VsaHwType	None	The type of hardware as ADC, Converter, or Input.
iChan	Integer	1	The hardware channel.  This is only used for the ADC hardware.
Remarks

An empty string is returned if there is no device for this hardware or you are simulating hardware.

See Also

About Selecting Hardware


Model Property

Get the hardware model for the specified hardware.

Applies To:	Hardware Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objHardware.Model(eHw, iChan)

Parameter	Data Type	Default Value	Description
eHw	VsaHwType	None
iChan	Integer	None
Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


Parameter Property

Get/set the named parameter for the specified hardware.

Applies To:	Hardware Object

Access:	Read/Write

Syntax:	Dim varVal As Variant
varVal = objHardware.Parameter(eHw, iChan, sName)
objHardware.Parameter(eHw, iChan, sName) = varVal

Parameter	Data Type	Default Value	Description
eHw	VsaHwType	None
iChan	Integer	None
sName	String	None
Remarks

Determine the setting for the named parameter of the specified hardware.  Some hardware has hardware-specific settings that are rarely changed.  This property allows you to set/get these hardware settings.  The ParameterNames property returns an array of strings representing the named parameters that can be configured on this hardware.

See Also

Configure Tab

ParameterNames Property


ParameterNames Property

Get the list of valid parameter names for the specified hardware.

Applies To:	Hardware Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objHardware.ParameterNames(eHw, iChan)

Parameter	Data Type	Default Value	Description
eHw	VsaHwType	None
iChan	Integer	None
Remarks

Returns an array of strings representing the named parameters that can be configured on this hardware.  These parameter names can be used with the Parameter property to set/get parameter Values.  An empty Variant is returned if the hardware has no configurable parameters.

See Also

Configure Tab


SaveAddresses Property

Get/set if addresses are saved when SetAddresses is called.

Applies To:	Hardware Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objHardware.SaveAddresses
objHardware.SaveAddresses = blnVal

Remarks

Determine whether hardware addresses are persistently saved when the SetAddresses method is called. The SetAddresses method provides a way to select the hardware that is used with the analyzer.

Saving the addresses provides a mechanism to select the hardware to be used and it being the same every time you run the analyzer.

See Also

Save Selection


SavedAddress Property

Returns the last saved address for the specified hardware.

Applies To:	Hardware Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objHardware.SavedAddress(eHw, [iChan])

Parameter	Data Type	Default Value	Description
eHw	VsaHwType	None	The type of hardware as ADC, Converter, or Input.
iChan	Integer	1	The hardware channel.  This is only used for the ADC hardware.
Remarks

The address for simulated hardware starts with "SIM::".  An empty string is returned if no devices is set for this type of hardware.

See Also

Hardware


SelectDefault Property

Get/set if the default addresses are selected.

Applies To:	Hardware Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objHardware.SelectDefault
objHardware.SelectDefault = blnVal

Remarks

Determine whether the analyzer should automatically determine the appropriate hardware to use with the analyzer.  If this is set to True, then the analyzer will scan the VXI mainframe looking for cards that the analyzer can utilize (ADC's, Down Converter, and Input Module).  If it finds a suitable configuration, it is used by default.  If more than one set of cards is found, the cards in the lowest number slots are used.  If no supported cards / configurations are found, then the default hardware simulation is used.

See Also

Default Configuration


SerialNumber Property

Get the serial number for the specified hardware.

Applies To:	Hardware Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objHardware.SerialNumber(eHw, [iChan])

Parameter	Data Type	Default Value	Description
eHw	VsaHwType	None	The type of hardware as ADC, Converter, or Input.
iChan	Integer	1	The hardware channel.  This is only used for the ADC hardware.
Remarks

An empty string is returned if there is no device for this hardware or you are simulating hardware.

See Also

Hardware


Simulate Property

Gets whether the current hardware is being simulated.

Applies To:	Hardware Object

Access:	Read only

Syntax:	Dim blnVal As Boolean
blnVal = objHardware.Simulate

Remarks

Even with hardware installed in the mainframe, the software can be configured to simulate hardware using hardware addresses that start with "SIM::".


SetAddresses Method

Set the addresses for the current ADC(s), down converter, and input module.

Applies To:	Hardware Object

Syntax:	objHardware.SetAddresses(sAdc1, sAdc2, sConverter, sInput)

Parameter	Data Type	Default Value	Description
sAdc1	String	None	String representing the address of the first A/D converter.
sAdc2	String	None	String representing the address of the second A/D converter.
sConverter	String	None	String representing the address of the down converter.
sInput	String	None	String representing the address of the input module.
Remarks

This method is identical to the SetAddressesEx method, except it does not allow you to set the address for an external source.  Furthermore, since the SetAddressesEx method only applies to the VsaVector application, you must use this method if you are using the VsaScalar application.

See Also

Hardware

Address Property


SetAddressesEx Method

(Vector only)

Set the addresses for the current ADC(s), down converter, input module and source.

Applies To:	Hardware Object

Syntax:	objHardware.SetAddressesEx(sAdc1, sAdc2, sConverter, sInput, sSource)

Parameter	Data Type	Default Value	Description
sAdc1	String	None	String representing the address of the first A/D converter.
sAdc2	String	None	String representing the address of the second A/D converter.
sConverter	String	None	String representing the address of the down converter.
sInput	String	None	String representing the address of the input module.
sSource	String	None	String representing the address of the external source.
Remarks

The Hardware object's SetAddressesEx method provides a way to configure the analyzer to use the specified hardware devices.  Simulated hardware devices have addresses that start with "SIM::".   The Address property can be used to get the address of any of the hardware devices currently used by the analyzer.

See Also

Hardware

Address Property


SetAddressesMultiChan Method

Set the addresses for the current ADC(s), down converter(s), input module(s) and source.

Applies To:	Hardware Object

Syntax:	objHardware.SetAddressesMultiChan(vAdc, vCnv, vInp, sSource)

Parameter	Data Type	Default Value	Description
vAdc	Variant	None
vCnv	Variant	None
vInp	Variant	None
sSource	String	None
Remarks

To learn how this feature works, see online help for the dialog box that lets you execute this function.


InpChannel Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Connector	R	Gets the current connector type for the channel.
Couple	RW	Get/set whether input coupling is AC or DC.
Impedance	R	Gets the current impedance for the channel.
Range	RW	Get/set the input range (in Vpk).
Ranges	R	Return an array of the allowable  input ranges (in Vpk).
RefImpedance	RW	Gets/sets the current reference impedance for the channel.
RefImpedanceIsConnector	RW	Get/set if RefImpedance is the same as the connector Impedance.
Methods	Description
RangeNearest	Return  the nearest actual range (in Volts) to the specified range.
SetConnectorImpedance	Sets the connector type and impedance for the channel.
Remarks

The InpChannel object is a member of the InpChannels collection, and represents an individual input channel in the mainframe.  The channels make up one possible source for the Measurement object.  There are 1 or 2 input channels in the application depending upon hardware selection.  You can specify the range and coupling of an input channel.

See Also

About Range and Coupling

Coupling Tab

Range Tab


Connector Property

Gets the current connector type for the channel.

Applies To:	InpChannel Object

Access:	Read only

Syntax:	Dim enumVal As VsaInpChanConnector
enumVal = objInpChannel.Connector

Remarks

Can be set via the SetConnectorImpedance method.

See Also

Impedance Property

RefImpedance Property

RefImpedanceIsConnector Property

SetConnectorImpedance Method

Input->Range. . . ->Range/Coupling tab


Couple Property

Get/set whether input coupling is AC or DC.

Applies To:	InpChannel Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaInpChanCouple
enumVal = objInpChannel.Couple
objInpChannel.Couple = enumVal

Remarks

Determine whether this input channel is AC or DC coupled.

Use DC coupling for small spans at low frequency to avoid the filter effect associated with AC coupling (signal 3 dB down at 1 Hz).

See Also

Coupling


Impedance Property

Gets the current impedance for the channel.

Applies To:	InpChannel Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objInpChannel.Impedance

Remarks

Can be set via the SetConnectorImpedance method.

See Also

Connector Property

RefImpedance Property

RefImpedanceIsConnector Property

SetConnectorImpedance Method

Input->Range. . . ->Range/Coupling tab


Range Property

Get/set the input range (in Vpk).

Applies To:	InpChannel Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objInpChannel.Range
objInpChannel.Range = dblVal

Remarks

Determine the range, in Volts (peak), of the input channel.

There are a limited set of allowable Values for the input range, which is dependant upon the ADC hardware, down converter, and input module configured for use with the analyzer.  The range specified is rounded to the next largest available range.

See Also

Range


Ranges Property

Return an array of the allowable  input ranges (in Vpk).

Applies To:	InpChannel Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objInpChannel.Ranges

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


RefImpedance Property

Gets/sets the current reference impedance for the channel.

Applies To:	InpChannel Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objInpChannel.RefImpedance
objInpChannel.RefImpedance = dblVal

Remarks

RefImpedanceIsConnector must be False to be able to set this value.

See Also

Connector Property

Impedance Property

RefImpedanceIsConnector Property

SetConnectorImpedance Method

Input->Range. . . ->Range/Coupling tab


RefImpedanceIsConnector Property

Get/set if RefImpedance is the same as the connector Impedance.

Applies To:	InpChannel Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objInpChannel.RefImpedanceIsConnector
objInpChannel.RefImpedanceIsConnector = blnVal

Remarks

Setting RefImpedanceIsConnector to True causes the value of RefImpedance to be set so it is identical to the impedance value of the connector.

See Also

Connector Property

Impedance Property

RefImpedance Property

SetConnectorImpedance Method

Input->Range. . . ->Range/Coupling tab


RangeNearest Method

Return  the nearest actual range (in Volts) to the specified range.

Applies To:	InpChannel Object

Syntax:	Dim dblVal As Double
dblVal = objInpChannel.RangeNearest(RangeVolts)

Parameter	Data Type	Default Value	Description
RangeVolts	Double	None	A Value specifying the desired range in Volts.
Remarks

Returns the nearest Valid range, in Volts peak, to the one specified in the RangeVolts parameter.  When you set the Range property, it calls this function to get the nearest range.

See Also

Range Property


SetConnectorImpedance Method

Sets the connector type and impedance for the channel.

Applies To:	InpChannel Object

Syntax:	objInpChannel.SetConnectorImpedance(conn, dImp)

Parameter	Data Type	Default Value	Description
conn	VsaInpChanConnector	None	The connector type
dImp	Double	None	The connector impedance in ohms.
Remarks

Setting the impedance also causes the RefImpedance to be set to the same value if RefImpedanceIsConnector is True.

See Also

Connector Property

Impedance Property

RefImpedance Property

RefImpedanceIsConnector Property

Input->Range. . . ->Range/Coupling tab


InpChannels Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Count	R	Get the number of input channels currently in use.
Item	-->	Get the specified InpChannel object.
Remarks

The InpChannels collection contains the individual input channels.

As with other collections, a read-only Count property reports the number of channels in the collection, and an Item property returns an individual member of the collection.


Count Property

Get the number of input channels currently in use.

Applies To:	InpChannels Object

Access:	Read only

Syntax:	Dim intVal As Integer
intVal = objInpChannels.Count

Remarks

The Count property is Read-only, and returns the number of individual items in the collection.


Item Property

Get the specified InpChannel object.

Applies To:	InpChannels Object

Syntax:	Dim objnpChannel As npChannel
Set objnpChannel = objInpChannels.Item(Index)

Parameter	Data Type	Default Value	Description
Index	Integer	None	Gets specified item.
Remarks

Two properties help to manage every collection.  The default property, Item, returns a reference to an object in the collection.

The other property of every collection is the read-only Count property, which returns the number of objects in the collection.  The Count property can then be used to iterate through the collection.

The Item property has an index parameter, which may be a numeric index (1 is first Value) of the object in the collection.  For the ArbSources, Macros, or MathFuncs object, the index may also be a string key, which is the name of the object (see Name property)

See Also

Count Property


Inputs Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
ChannelConfig	RW	Get/set how the input channels are connected to the measurement.
DataFrom †	RW	Get/set whether measurement data comes from the hardware or a recording.
InpChannels	-->	Get the InpChannels object.
Recording †	-->	Get the Recording object.
Trigger	-->	Get the Trigger object.
Methods	Description
FromSpecAnalyzer †	Set the measurement inputs to match that of a running Spectrum Analyzer application.
Remarks

The Inputs object represents the front-end of the instrument, permitting configuration and selection of the input channels.

You can also select whether input data comes from the input channels or from a recording.  You can use the Recording object to control recording and playback settings.

See Also

Input Menu

About Input Channels


ChannelConfig Property

Get/set how the input channels are connected to the measurement.

Applies To:	Inputs Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaInpsChannelConfig
enumVal = objInputs.ChannelConfig
objInputs.ChannelConfig = enumVal

Remarks

You can specify to use 1 channel, 2 independent channels, or 2 baseband channels combined into one complex Virtual channel.  The two channel modes are only available if two channels are available to the analyzer and the combined mode only if the channels are baseband.

See Also

Trigger Tab


DataFrom Property

(Vector only)

Get/set whether measurement data comes from the hardware or a recording.

Applies To:	Inputs Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaInpsDataFrom
enumVal = objInputs.DataFrom
objInputs.DataFrom = enumVal

Remarks

When you select data from a recording, the recording resides in a file, by default, the Recording.sdf file in your DATA directory.  You can change the location of the file with the TempFile property.  When you make a new recording from the hardware (Measurement.Record), the TempFile is over written.  If you want to keep a recording, you need to save it to another file (Recording.SaveFile).

Note that when you play back a recording, (even if it has been saved to a file and then recalled), you are playing the raw digital data, and it plays back as if it were any other input.  This means that you can further manipulate the data, making additional measurements.

Conversely, when you save a trace to a file, you save the result of the particular measurement in effect at the time.  This means that you cannot replay it as either input or recording, because you are no longer able to manipulate the data, only the presentation.  Traces saved are re-displayed Via the data registers.

Note

When you save a Trace or a Recording, header information should always be included unless you intend to import the data into another application such as a database or some other signal analysis program and you want only the data in the file.  Without the header data, the VsaVector and VsaScalar applications cannot reproduce the measurement conditions in effect when the trace or recording was created.  Details can be found in the online help book on Sharing Data.

See Also

Input Menu

Saving a Recording


InpChannels Property

Get the InpChannels object.

Applies To:	Inputs Object

Syntax:	Dim objInpChannels As InpChannels
Set objInpChannels = objInputs.InpChannels

Remarks

InpChannels (a property of the Inputs object) returns an InpChannels object.

See Also

InpChannels Object


Recording Property

(Vector only)

Get the Recording object.

Applies To:	Inputs Object

Syntax:	Dim objRecording As Recording
Set objRecording = objInputs.Recording

Remarks

Recording (a property of the Inputs object) returns a Recording object.

See Also

Recording Object


Trigger Property

Get the Trigger object.

Applies To:	Inputs Object

Syntax:	Dim objTrigger As Trigger
Set objTrigger = objInputs.Trigger

Remarks

Trigger (a property of both the Inputs and Recording objects) returns a Trigger object.

See Also

Trigger Object


FromSpecAnalyzer Method

(Vector only)

Set the measurement inputs to match that of a running Spectrum Analyzer application.

Applies To:	Inputs Object

Syntax:	objInputs.FromSpecAnalyzer

Remarks

This method copies the following input parameters from a running Spectrum Analyzer application.  If no VsaScalar application is running, then an error is raised.

•	Range - for each channel

•	Coupling - for each channel

•	Trigger.Style

•	Trigger.Slope

•	Trigger.Channel

•	Trigger.Delay

•	Trigger.Holdoff

•	Trigger.ExtLevel

•	Trigger.MagLevel

•	Trigger.Level


License Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Level	R	Get the license level.
LevelName	R	Get the name of the license level.
OptionCode	R	Get the code of the specified option.
OptionCount	R	Get the maximum number of options available.
OptionEnable	R	Get whether the the specified option is enabled.
OptionName	R	Get the name of the specified option.
Remarks

The License object provides programmatic access to a number of read-only properties that describe the license of the running software.  Note that if no Valid licenses exist, the application will not start, and therefore this information will be unavailable.

It is not possible to transfer licenses or do any other licensing activities programmatically; this object is provided simply as a convenient way for your program to check that the active licenses are appropriate for the features your program will be exercising.

See Also

License Dialog Box


Level Property

Get the license level.

Applies To:	License Object

Access:	Read only

Syntax:	Dim intVal As Integer
intVal = objLicense.Level

Remarks

Returns the level of the license.  The level is derived from the application Version.  An older application has a smaller license level.  The LevelName property returns the name associated with this license level.


LevelName Property

Get the name of the license level.

Applies To:	License Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objLicense.LevelName

Remarks

Returns the name of the application license level.  The Level property returns the associated license level.  An older application has a smaller license level.

See Also

Level Property


OptionCode Property

Get the code of the specified option.

Applies To:	License Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objLicense.OptionCode(eOpt)

Parameter	Data Type	Default Value	Description
eOpt	VsaLicOption	None	A VsaLicOption enumeration that represents the license option.
Remarks

Each license option has a three letter/number code associated with it.  This function returns a string representing this code for the specified option.  The option codes are shown in the License dialog Options tab.

See Also

Options

OptionCount Property

OptionEnable Property

OptionName Property


OptionCount Property

Get the maximum number of options available.

Applies To:	License Object

Access:	Read only

Syntax:	Dim intVal As Integer
intVal = objLicense.OptionCount

Remarks

This property is useful to be able to iterate through the options to determine the option code (OptionCode property), whether the option is enabled (OptionEnable property), and the name of the option (OptionName property).


OptionEnable Property

Get whether the the specified option is enabled.

Applies To:	License Object

Access:	Read only

Syntax:	Dim blnVal As Boolean
blnVal = objLicense.OptionEnable(eOpt)

Parameter	Data Type	Default Value	Description
eOpt	VsaLicOption	None	A constant that specifies a license option.
Remarks

Returns whether the specified option is enabled.  If the option is not enabled, then some functionality is disabled in the analyzer.  The states of all options are shown in the License dialog Options tab.

See Also

Options


OptionName Property

Get the name of the specified option.

Applies To:	License Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objLicense.OptionName(eOpt)

Parameter	Data Type	Default Value	Description
eOpt	VsaLicOption	None	A constant that specifies a license option.
Remarks

Returns the name of the specified option, as seen in the License dialog Options tab.

See Also

Options


Macro Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Code	RW	Get/set the macro code.
Name	RW	Get/set the macro name.
Picture	-->	Get/set the picture that appears on the macro tool bar.
Methods	Description
Remove	Remove this macro.
Run	Run the macro.
Save	Save any changes made to this macro.
Remarks

The Macro object represents an individual VBScript macro by name. This object's available methods permit you to save, delete, or run a macro, and check its syntax.  The object's properties contain its code, name, and an associated bitmap.  The bitmap is used as an icon if you wish to include a macro on the application's toolbar.

The application stores macros to files in the DATA directory and automatically appends the extension VBS.  Note that VsaScalar and VsaVector do not share macros.

See Also

Macros Dialog Box


Code Property

Get/set the macro code.

Applies To:	Macro Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objMacro.Code
objMacro.Code = strVal

Remarks

A Macro object's code property is the VBScript code that makes up the macro. When you create a macro, the analyzer automatically stores it as a VBS file in the DATA directory.  For the file name, the analyzer uses the same name you assign to the macro, and appends the VBS extension.  A Carriage Return/Line Feed (vbCrLf) separates each line of the macro.

See Also

Creating a Macro

Macros Dialog Box


Name Property

Get/set the macro name.

Applies To:	Macro Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objMacro.Name
objMacro.Name = strVal

Remarks

The name of the object must be unique within its collection and must only contain characters that are allowed in file names. Leading and trailing spaces are stripped from the name before use. When an object is created, it is automatically initialized with a unique name.


Picture Property

Get/set the picture that appears on the macro tool bar.

Applies To:	Macro Object

Syntax:	Dim objPicture As Picture
Set objPicture = objMacro.Picture

Remarks

Determine the bitmap image (the picture) that is used as a toolbar icon to represent the macro.  The bitmaps are saved as BMP files with the same name as the macro in the DATA directory.

See Also

Picture Select


Remove Method

Remove this macro.

Applies To:	Macro Object

Syntax:	objMacro.Remove

Remarks

Removes a single ArbSource object, macro, or math expression.

See Also

Macros Delete

RemoveAll Method


Run Method

Run the macro.

Applies To:	Macro Object

Syntax:	objMacro.Run

Remarks

The Run method runs a macro and returns when the macro is finished.

See Also

Run


Save Method

Save any changes made to this macro.

Applies To:	Macro Object

Syntax:	objMacro.Save

Remarks

When you are finished changing a macro or math function, you call the Save method to persist the macro or math function to its associated file.  The macros and math functions are saved to the DATA directory with file names that are the same as the macro/math function names.  The extension VBS is added for macros, and MTH is added for math functions.


MacroRun2 Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Methods	Description
VsaDoEvents	Do event handling.
VsaInputBox	Displays a prompt in a dialog box and returns user input text.
VsaListBox	Displays a set of choices in a dialog box and returns user's selection.
VsaMsgBox	Displays a dialog box and returns the value of the user's selection.
VsaSleep	Sleep for specified time (in mSec).
Remarks

The MacroRun2 object is referred to as a "pseudo-object".  Its methods are exposed to VBScript macros as global functions at runtime, and they provide the following added functionality to your programs:

•	VsaDoEvents lets you check for mouse, keyboard, and other notification events that occur while a macro is running.

•	VsaSleep pauses a macro momentarily to give more processor time to the measurement.

•	VsaInputBox displays a user entry dialog.

•	VsaListBox presents you with a list of choices in the form of a combobox, and returns the selection to the calling macro.

•	VsaMsgBox displays a message dialog.

See Also

You will find descriptions of these functions in Special Functions and Constants topic in macros online help.


VsaDoEvents Method

Do event handling.

Applies To:	MacroRun2 Object

Syntax:	objMacroRun2.VsaDoEvents

Remarks

This method applies to the MacroRun Object and is only for use with macros.  For details, see VsaDoEvents in the macros online help.


VsaInputBox Method

Displays a prompt in a dialog box and returns user input text.

Applies To:	MacroRun2 Object

Syntax:	Dim varVal As Variant
varVal = objMacroRun2.VsaInputBox(sPrompt, [vTitle], [vDefault], [vxPos], [vyPos])

Parameter	Data Type	Default Value	Description
sPrompt	String	None	Prompt to display in the input box
vTitle	Variant	None	Optional. String expression displayed in the title bar of the dialog box. If you omit title, the application name is placed in the title bar
vDefault	Variant	None	Optional. String expression displayed in the text box as the default response if no other input is provided. If you omit default, the text box is displayed empty
vxPos	Variant	None	Optional. Numeric expression that specifies, in twips, the horizontal distance of the left edge of the dialog box from the left edge of the screen. If xpos is omitted, the dialog box is horizontally centered.
vyPos	Variant	None	Optional. Numeric expression that specifies, in twips, the Vertical distance of the upper edge of the dialog box from the top of the screen. If ypos is omitted, the dialog box is Vertically positioned approximately one-third of the way down the screen
Remarks

This method applies to the MacroRun Object and is only for use with macros.  For details, see VsaInputBox in the macros online help.


VsaListBox Method

Displays a set of choices in a dialog box and returns user's selection.

Applies To:	MacroRun2 Object

Syntax:	Dim varVal As Variant
varVal = objMacroRun2.VsaListBox(sTitle, vListItems, [vDefaultItem], [vSorted], [vxPos], [vyPos])

Parameter	Data Type	Default Value	Description
sTitle	String	None	String that appears in the title bar of the dialog.
vListItems	Variant	None	Array of strings that are to be displayed as list items.
vDefaultItem	Variant	None	(Optional) List item that is to be selected by default.
vSorted	Variant	None	(Optional) Specify "True" to sort the items in the list.   "False" (default) displays items in the order specified in vListItems.
vxPos	Variant	None	(Optional) The X position of the dialog box on the screen (in twips - 15 twips to the pixel, ~1440 twips per inch).
vyPos	Variant	None	(Optional) The Y position of the dialog box on the screen (in twips).
Remarks

This method applies to the MacroRun Object and is only for use with macros.  It displays a set of choices in a drop-down list and returns the selected string to the caller.


VsaMsgBox Method

Displays a dialog box and returns the value of the user's selection.

Applies To:	MacroRun2 Object

Syntax:	Dim enumVal As VbMsgBoxResult
enumVal = objMacroRun2.VsaMsgBox(sPrompt, [vButtons], [vTitle])

Parameter	Data Type	Default Value	Description
sPrompt	String	None	Message to display in message box.
vButtons	Variant	None	Buttons to display in message box (such as VbOKonly or VbOKCancel).
vTitle	Variant	None	Title of message box
Remarks

This method applies to the MacroRun Object and is only for use with macros.  For details, see VsaMsgBox in the macros online help.


VsaSleep Method

Sleep for specified time (in mSec).

Applies To:	MacroRun2 Object

Syntax:	objMacroRun2.VsaSleep(dwMilliseconds)

Parameter	Data Type	Default Value	Description
dwMilliseconds	Long	None	The amount of time to suspend execution, in milliseconds
Remarks

This method applies to the MacroRun Object and is only for use with macros.  For details, see VsaSleep in the macros online help.


Macros Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Count	R	Get the number of macros currently defined.
Item	-->	Get the specified Macro object.
Methods	Description
CheckSyntax	Returns true if the specified macro code has no syntax errors.
NewMacro	Returns a new (created) Macro object.
RemoveAll	Remove all macros.
Reset	Stop any running macros
Remarks

The Macros object is a collection of Macro (VBScript) objects.

The Macros object provides methods to create a new macro, check code syntax, select one of the macros, and to remove all macros from the collection.  Note that removing the macros not only removes them from memory, but also permanently deletes the VBS files in the DATA directory.

As with other collections, a read-only Count property reports the number of macros in the collection, and an Item property (indexed by either position or macro name) returns an individual member of the collection.  Note that VsaScalar and VsaVector do not share macros.

See Also

Macros Dialog Box


Count Property

Get the number of macros currently defined.

Applies To:	Macros Object

Access:	Read only

Syntax:	Dim lngVal As Long
lngVal = objMacros.Count

Remarks

The Count property is Read-only, and returns the number of individual items in the collection.


Item Property

Get the specified Macro object.

Applies To:	Macros Object

Syntax:	Dim objMacro As Macro
Set objMacro = objMacros.Item(vIndexKey)

Parameter	Data Type	Default Value	Description
vIndexKey	Variant	None	Gets specified item.
Remarks

Two properties help to manage every collection.  The default property, Item, returns a reference to an object in the collection.

The other property of every collection is the read-only Count property, which returns the number of objects in the collection.  The Count property can then be used to iterate through the collection.

The Item property has an index parameter, which may be a numeric index (1 is first Value) of the object in the collection.  For the ArbSources, Macros, or MathFuncs object, the index may also be a string key, which is the name of the object (see Name property)

See Also

Count Property

Name Property


CheckSyntax Method

Returns true if the specified macro code has no syntax errors.

Applies To:	Macros Object

Syntax:	objMacros.CheckSyntax(sCode)

Parameter	Data Type	Default Value	Description
sCode	String	None	Finds syntax erros in macro code.
Remarks

The CheckSyntax method checks the syntax of math expression or VBScript macro passed as a parameter.  If a syntax error is found, an error is raised.

See Also

Check Syntax (Macros)

Check Syntax (Math)


NewMacro Method

Returns a new (created) Macro object.

Applies To:	Macros Object

Syntax:	Dim objNewMacro As Macro
Set objNewMacro = objMacros.NewMacro

Remarks

Returns a reference to a new empty macro.  The Code property sets the VBScript code for the macro and the Name property changes the macro name.

See Also

New


RemoveAll Method

Remove all macros.

Applies To:	Macros Object

Syntax:	objMacros.RemoveAll

Remarks

The RemoveAll method removes all the ArbSource, Macro or MathFunc objects from the collection, and from persistent memory.


Reset Method

Stop any running macros

Applies To:	Macros Object

Syntax:	objMacros.Reset

Remarks

Resets a measurement.  This stops a running measurement immediately and clears all measurement data.  You should use the Pause method instead of Reset if you want the stop the measurement at the end of the measurement loop and want to retain the measurement data.

See Also

Stop


Marker Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
BandPower	RW	Get/set if the band power marker is visible.
BandPowerCalc	RW	Get/set the type of band power calculation.
BandPowerLeft	RW	Get/set the x-axis left side of the band power calculation.
BandPowerResult	R	Get the last calculated band power result.
BandPowerResultQ	R	Get the last calculated band power result for the Q part of dual I/Q data.
BandPowerResultUnit	R	Get the unit string of the last calculated band power result.
BandPowerRight	RW	Get/set the x-axis right side of the band power calculation.
Carrier †	RW	Get/set if the carrier marker is visible.
CarrierResult †	R	Get the result of the carrier marker.
CodeChannel	R	Get the marker x-axis demod code channel.
Consolidate †	RW	Get/set if the code domain Y marker values are consolidated.
Couple	RW	Get/set if the marker x-axis position is coupled to the marker on another trace.
FreqCount	RW	Get/set if the frequency count marker is visible.
FreqCountResult	R	Get the result of the frequency count marker.
IQBranch	R	Get if the marker is on the I or Q part of a dual I/Q trace.
OffsetTraceTime	RW	Get/set the offset marker trace time position.
OffsetVisible	RW	Get/set if the offset marker is visible.
OffsetX	RW	Get/set the offset marker x-axis position.
OffsetY	RW	Get/set the offset marker y-axis position.
OffsetZ	RW	Get/set the offset marker z-axis position.
PeakTrack	RW	Get/set whether the marker tracks the peak of the data.
Point	RW	Get/set the marker x-axis position by point number (0 is first point).
PolarFormat	RW	Get/set if x-vs-y trace formats show markers as real/imaginary or magnitude/phase.
Slot	R	Get the slot associated with the current marker position.
SymbolRate	R	Get the symbol rate associated with the current marker position.
TraceSelect	RW	Get/set the spectrogram trace that is selected.
TraceSelectVisible	RW	Get/set if spectrogram TraceSelect is enabled.
TraceTime	R	Get the marker trace time position.
Value	RW	Get/set the marker position by x-axis value.
ValueUnit	R	Get the unit associated with the marker Value.
Visible	RW	Get/set if the marker is visible.
X	R	Get the marker x-axis value.
Y	R	Get the marker y-axis value.
YAverage	R	Get the marker y-axis average value.
Z	RW	Get/set the marker position by z-axis value.
ZUnit	R	Get the unit associated with the marker z-axis value.
Methods	Description
MoveTo	Move the marker to the specified peak/min value.
Remarks

The Marker object lets you:

•	Position markers

•	Position offset markers

•	Couple markers on one trace to markers on other traces

•	Perform marker calculations.

Each trace has its own marker and offset marker.  The marker helps you determine the x-axis and y-axis position for any point on a trace.  The offset marker helps you determine how far another point is from the marker.

Either the Value or Point property may be used to move the marker, while the X and Y read-only properties are used to retrieve the marker's X and Y-axis Value.  In addition, you can use the MoveTo method to move the marker to a specified peak.  The marker is displayed on the trace as a diamond.

The offset marker is not constrained to be on the trace's data, but has a user selectable X and Y position.  You can use the OffsetX and OffsetY properties to move the offset marker.  The offset marker is displayed on the trace as a square.

Marker calculations include band power, frequency counter measurement, and analog demod carrier display.

See Also

About Markers


BandPower Property

Get/set if the band power marker is visible.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objMarker.BandPower
objMarker.BandPower = blnVal

Remarks

You must also specify the calculation region (BandPowerLeft and BandPowerRight properties) and the type of calculation (BandPowerCalc property).  The BandPowerResult and BandPowerResultUnit properties return the calculated band power and unit, respectively.

See Also

Band Power


BandPowerCalc Property

Get/set the type of band power calculation.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaMkrBndPwrCalc
enumVal = objMarker.BandPowerCalc
objMarker.BandPowerCalc = enumVal

Remarks

The BandPowerCalc property determines the type of calculation to be applied to the data between the band power markers (BandPowerLeft and BandPowerRight properties). The BandPowerResult and BandPowerResultUnit properties return the calculated band power and unit, respectively.

See Also

Calculation Tab

Calculate


BandPowerLeft Property

Get/set the x-axis left side of the band power calculation.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objMarker.BandPowerLeft
objMarker.BandPowerLeft = dblVal

Remarks

The band power calculation is applied to the data between the band power markers (BandPowerLeft and BandPowerRight properties).  It does not matter if BandPowerLeft is greater that the BandPowerRight property, the calculation will still be on all data between the two Values.  In the application's user interface, you can set and display the band power marker range as Center/Width or Left/Right, but programmatically you can only set the left and right Values.

See Also

Bandpower Left


BandPowerResult Property

Get the last calculated band power result.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objMarker.BandPowerResult

Remarks

To make a band power calculation, you must turn on band power calculations (BandPower property), specify the calculation region (BandPowerLeft and BandPowerRight properties), and the type of calculation (BandPowerCalc property).  The BandPowerResultUnit property returns the unit of the calculated band power.

See Also

Band Power


BandPowerResultQ Property

Get the last calculated band power result for the Q part of dual I/Q data.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objMarker.BandPowerResultQ

Remarks

For the 3GPP uplink Code Domain Power measurement result, the band power is calculated separately for the I- and Q-parts of the data.  This property returns the Q-part of the band power calculation.


BandPowerResultUnit Property

Get the unit string of the last calculated band power result.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objMarker.BandPowerResultUnit

Remarks

To make a band power calculation, you must turn on band power calculations (BandPower property), specify the calculation region (BandPowerLeft and BandPowerRight properties), and the type of calculation (BandPowerCalc property).  The BandPowerResult property returns the calculated band power to accompany this unit.

See Also

Band Power


BandPowerRight Property

Get/set the x-axis right side of the band power calculation.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objMarker.BandPowerRight
objMarker.BandPowerRight = dblVal

Remarks

The band power calculation is applied to the data between the band power markers (BandPowerLeft and BandPowerRight properties).  It does not matter if BandPowerLeft is greater that the BandPowerRight property, the calculation will still be on all data between the two Values.  In the application's user interface, you can set and display the band power marker range as Center/Width or Left/Right, but programmatically you can only set the left and right Values.

See Also

Bandpower Right


Carrier Property

(Vector only)

Get/set if the carrier marker is visible.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objMarker.Carrier
objMarker.Carrier = blnVal

Remarks

The Carrier property determines if the calculated carrier of an analog demodulation measurement will be displayed in the marker text window.

See Also

Analog Demod Carrier


CarrierResult Property

(Vector only)

Get the result of the carrier marker.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objMarker.CarrierResult

Remarks

The CarrierResult property returns the calculated carrier of an analog demodulation measurement.  The carrier marker (Carrier property) must be turned on before you can get the carrier marker result.  The carrier is zero if there is no carrier present.

See Also

Analog Demod Carrier


CodeChannel Property

Get the marker x-axis demod code channel.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim lngVal As Long
lngVal = objMarker.CodeChannel

Remarks

Points in a W-CDMA Code Domain Power measurement result are at a calculated code channel and symbol rate.  This property returns the code channel for the data at the current marker position.


Consolidate Property

(Vector only)

Get/set if the code domain Y marker values are consolidated.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objMarker.Consolidate
objMarker.Consolidate = blnVal

Remarks

Data values in a 3G Code Domain Power measurement result that are not at the base symbol rate are contained in multiple points in the trace.  If the trace is shown in bit reverse code order, then these points will be next to each other.  If the code order is Hadamard, then these points will be spread out through the trace.  If marker.Consolidate is True, then a marker will be shown at all points for this data value (same code channel / symbol rate).

See Also

DemodCodeOrder Property

Consolidate (when Code Order is Hadamard)


Couple Property

Get/set if the marker x-axis position is coupled to the marker on another trace.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objMarker.Couple
objMarker.Couple = blnVal

Remarks

True if a marker's X-axis position is coupled to the marker on another trace.  All markers that are coupled and have the same X-axis units will have the same X-axis position, if possible.  If the couple markers X-axis do not have the same resolution or range, then the markers are positioned as close to each other as possible.

See Also

Position Tab (Markers)


FreqCount Property

Get/set if the frequency count marker is visible.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objMarker.FreqCount
objMarker.FreqCount = blnVal

Remarks

This property enables or disables the display of the frequency count marker.

See Also

Frequency Counter


FreqCountResult Property

Get the result of the frequency count marker.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objMarker.FreqCountResult

Remarks

Returns the last calculated frequency count, in Hertz.  To make a frequency count calculation, you must turn on the main marker (Visible set to True) and turn on the frequency count marker (FreqCount set to True) on a frequency domain trace.  Zero is returned if a Valid calculation cannot be made.


IQBranch Property

Get if the marker is on the I or Q part of a dual I/Q trace.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim enumVal As VsaMkrIQBranch
enumVal = objMarker.IQBranch

Remarks

The 3GPP uplink Code Domain Power measurement result contains both I and Q data which are shown at the same time.  This property returns whether the marker is on an I- or a Q-point.


OffsetTraceTime Property

Get/set the offset marker trace time position.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objMarker.OffsetTraceTime
objMarker.OffsetTraceTime = dblVal

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


OffsetVisible Property

Get/set if the offset marker is visible.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objMarker.OffsetVisible
objMarker.OffsetVisible = blnVal

Remarks

Determine whether the offset marker is Visible.  The OffsetX and OffsetY properties set an arbitrary X and Y position for the offset marker.  The offset marker is shown on the trace as a small box.  The annotation for the main marker is calculated as an offset from the offset marker position.

The main marker must be Visible for the offset to be Visible.  If this property is set to True and the main marker is not Visible, it is automatically made Visible.  Also, if the main marker is turned off (Visible set to False), then the offset marker is turned off.

See Also

Offset Marker

OffsetX Property

OffsetY Property


OffsetX Property

Get/set the offset marker x-axis position.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objMarker.OffsetX
objMarker.OffsetX = dblVal

Remarks

Determine the location on the X axis of the offset marker.  The X position is in the same units as the trace X axis (Trace.XaxisUnit).  Unlike the main marker, the offset marker is not located on the trace data, but is at an arbitrary position, determined by the OffsetX and OffsetY properties.

See Also

X Position


OffsetY Property

Get/set the offset marker y-axis position.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objMarker.OffsetY
objMarker.OffsetY = dblVal

Remarks

Determine the location on the Y axis of the offset marker.  The Y position is in the same units as the trace Y axis (Trace.YaxisUnit).  Unlike the main marker, the offset marker is not located on the trace data, but is at an arbitrary position, determined by the OffsetX and OffsetY properties.

See Also

Y Position


OffsetZ Property

Get/set the offset marker z-axis position.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objMarker.OffsetZ
objMarker.OffsetZ = dblVal

Remarks

The z-axis is only used for some OFDM trace data types (e.g. Error Vector Spectrum).

See Also

Z Property

ZUnit Property

Markers -> Position -> Offset Marker -> Z Position


PeakTrack Property

Get/set whether the marker tracks the peak of the data.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objMarker.PeakTrack
objMarker.PeakTrack = blnVal

Remarks

If peak track is on, then the marker is moved to the peak of the trace every time new data is displayed on the trace.  The marker must be on (Visible set to True) for this property to have any effect.

See Also

Peak Track


Point Property

Get/set the marker x-axis position by point number (0 is first point).

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objMarker.Point
objMarker.Point = lngVal

Remarks

Determine the domain axis position of the marker by its offset, in points, from the start of the trace data.  This is the position of the marker in the time/frequency axis.  This is the same as the x axis for all trace formats except I-Q and constellation.  The position must be at least 0 (start of data) and less that the number of points in the trace.  You can also use the Value property to change the marker position, which is in the units of the time/frequency axis.

If the markers are coupled (Couple set to True), then setting this property could change the marker position in other traces that have coupled markers.

See Also

X Position


PolarFormat Property

Get/set if x-vs-y trace formats show markers as real/imaginary or magnitude/phase.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaMkrPolar
enumVal = objMarker.PolarFormat
objMarker.PolarFormat = enumVal

Remarks

Determine whether the marker annotation will be shown as magnitude/phase or real/imaginary.  This property is only used if the trace format is I-Q or constellation.

See Also

Polar Format

Markers Position Tab


Slot Property

Get the slot associated with the current marker position.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objMarker.Slot

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


SymbolRate Property

Get the symbol rate associated with the current marker position.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objMarker.SymbolRate

Remarks

Points in a 3G Code Domain Power measurement result are at a calculated code channel and symbol rate.  This property returns the symbol rate for the data at the current marker position.


TraceSelect Property

Get/set the spectrogram trace that is selected.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objMarker.TraceSelect
objMarker.TraceSelect = lngVal

Remarks

If TraceSelectVisible is True, then this property selects the current scan on a spectrogram trace.  The marker value is shown on the current scan.  Also, if another trace is showing the same result as this trace, then that trace shows the current scan.

See Also

TraceSelectVisible Property


TraceSelectVisible Property

Get/set if spectrogram TraceSelect is enabled.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objMarker.TraceSelectVisible
objMarker.TraceSelectVisible = blnVal

Remarks

This property selects whether you control the current scan on a spectrogram trace.  If TraceSelectVisible is True, then the Marker.TraceSelect is the current scan, otherwise the current scan is the last (most recent) scan of the spectrogram.  The marker value is shown on the current scan.  Also, if another trace is showing the same result as this trace, then that trace shows the current scan.

See Also

TraceSelect Property

Trace Select


TraceTime Property

Get the marker trace time position.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objMarker.TraceTime

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


Value Property

Get/set the marker position by x-axis value.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objMarker.Value
objMarker.Value = dblVal

Remarks

Determine the time/frequency axis position of the marker by its time/frequency axis position.  This is the same as the X-axis position for all trace formats except I-Q and constellation.  The position must be within the data in the trace.  If it is not, then the marker position is moved to the closest available position.  You can also use the Point property to change the marker position, which is in the units of points.

The ValueUnit property returns the time/frequency axis unit string of the marker.

If the markers are coupled (Couple set to True), then setting this property could change the marker position in other traces that have coupled markers.


ValueUnit Property

Get the unit associated with the marker Value.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objMarker.ValueUnit

Remarks

The marker Value is the time/frequency axis marker location that you set with the Value property.  The ValueUnit is the same as the trace x axis unit (Trace.XaxisUnit property) for all trace formats except I-Q and constellation.

See Also

X Position


Visible Property

Get/set if the marker is visible.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objMarker.Visible
objMarker.Visible = blnVal

Remarks

It is useful to hide the analyzer window if you are programming and do not need to see any displayed data or do not want a user to access the analyzer's user interface.

When you create the application object programmatically, Visible is defaulted to False.  If you start the application from a user interface, Visible is defaulted to True.

For the spectrogram object, this property sets or gets whether the spectrogram is turned on (TRUE = on, FALSE = off).  The data in the spectrogram is cleared when the spectrogram is turned off.


X Property

Get the marker x-axis value.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objMarker.X

Remarks

Returns the location of the marker on the X axis.  This is the same as the Value property if the trace format is not I-Q or constellation.  The Trace.XAxisUnit property contains the unit string for the X axis marker location

See Also

Value Property

Trace.XAxisUnit Property

Format Property


Y Property

Get the marker y-axis value.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objMarker.Y

Remarks

The marker's Point or Value properties determine where the marker is located on the data.  The Y property returns the calculated Y axis Value of the data at that point.  The Trace.YAxisUnit property contains the unit string for the Y axis marker location

See Also

Point Property

Value Property

YAxisUnit Property


YAverage Property

Get the marker y-axis average value.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objMarker.YAverage

Remarks

The y-axis average value is only computed if a z-azis is present in the data (only used for some OFDM trace data types, such as Error Vector Spectrum).  The average value is the y-axis RMS average for all points at the current x-axis value.

See Also

ZAxisUnit

ZPosition + Offset ZPosition


Z Property

Get/set the marker position by z-axis value.

Applies To:	Marker Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objMarker.Z
objMarker.Z = dblVal

Remarks

The z-axis is only used for some OFDM trace data types (e.g. Error Vector Spectrum).

See Also

OffsetZ Property

ZUnit Property

Markers -> Position -> Marker -> Z Position

ZPosition + Offset ZPosition


ZUnit Property

Get the unit associated with the marker z-axis value.

Applies To:	Marker Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objMarker.ZUnit

Remarks

The z-axis units are associated with the Z and OffsetZ properties.  The z-axis is only used for some OFDM trace data types (e.g. Error Vector Spectrum).  The z-axis unit for Error Vector Spectrum can be set with the Trace.DemodTimeUnit property.  The z-axis unit for Error Vector Time can be set with the Trace.DemodFreqUnit property.

See Also

OffsetZ Property

Z Property

Trace->DigitalDemod->Frequency Unit

Trace->DigitalDemod->Time Unit

ZPosition + ZOffset Position


MoveTo Method

Move the marker to the specified peak/min value.

Applies To:	Marker Object

Syntax:	objMarker.MoveTo(eMove)

Parameter	Data Type	Default Value	Description
eMove	VsaMkrMove	None	A constant that specifies the a marker move operation.
Remarks

The Marker object's MoveTo method moves the marker to a new location, according to the passed parameter, as follows:

•	vsaMkrMovePeak - Move the marker to the largest Value.

•	vsaMkrMoveMin - Move the marker to the smallest Value.

•	vsaMkrMoveLargerPeak - Move the marker to the next peak larger than the current marker Y Value.

•	vsaMkrMoveSmallerPeak - Move the marker to the next peak smaller than the current marker Y Value.

•	vsaMkrMoveLeftPeak - Move the marker to the next peak to the left of the current marker X position.

•	vsaMkrMoveRightPeak - Move the marker to the next peak to the right of the current marker X position.

See Also

Search


MathFunc Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Name	RW	Get/set the math function name.
Text	RW	Get/set the math function expression.
Methods	Description
Remove	Remove this math function.
Save	Save any changes made to this math function.
Remarks

The MathFunc object represents an individual math function.  This object's available methods permit you to save, delete, or set its name and text.

The measurement uses a math function when it is selected for display on a trace using the Trace.DataName property.  The list of available data names for math functions is returned by the Trace.DataNamesMath property.  The Trace.DataName for a math function is the math function name prefaced with "Fn ".

The application stores math functions to files in the DATA directory and automatically appends the extension MTH.  Note that VsaScalar and VsaVector do not share math functions.

See Also

About Math Functions


Name Property

Get/set the math function name.

Applies To:	MathFunc Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objMathFunc.Name
objMathFunc.Name = strVal

Remarks

The name of the object must be unique within its collection and must only contain characters that are allowed in file names. Leading and trailing spaces are stripped from the name before use. When an object is created, it is automatically initialized with a unique name.


Text Property

Get/set the math function expression.

Applies To:	MathFunc Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objMathFunc.Text
objMathFunc.Text = strVal

Remarks

The Text property is the string of text that makes up the mathematical function.  A math function can contain:

•	Trace data or data registers

•	Add, subtract, multiply, divide math operations

•	Real or complex constants

•	Math functions

The MathFuncs.CheckSyntax method can be used to see if this text is a Valid math function.

See Also

Expression


Remove Method

Remove this math function.

Applies To:	MathFunc Object

Syntax:	objMathFunc.Remove

Remarks

Removes a single ArbSource object, macro, or math expression.

See Also

Math Delete

RemoveAll Method


Save Method

Save any changes made to this math function.

Applies To:	MathFunc Object

Syntax:	objMathFunc.Save

Remarks

When you are finished changing a macro or math function, you call the Save method to persist the macro or math function to its associated file.  The macros and math functions are saved to the DATA directory with file names that are the same as the macro/math function names.  The extension VBS is added for macros, and MTH is added for math functions.


MathFuncs Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Count	R	Get the number of math functions currently defined.
Item	-->	Get the specified MathFunc object.
SyntaxErrorPos	R	Get the position of the last error found by CheckSyntax
Methods	Description
CheckSyntax	Checks to see whether the text represents a valid math function
NewMathFunc	Returns a new (created) MathFunc object.
RemoveAll	Remove all math functions
Remarks

The MathFuncs object is a collection of MathFunc (mathematical function) objects.

The MathFuncs object provides methods to create a new math function, check expression syntax, select one of the math functions, and to remove all macros from the collection. Note that removing the math functions not only removes them from memory, but also permanently deletes the MTH files in the DATA directory.

As with other collections, a read-only Count property reports the number of functions in the collection, and an Item property (indexed by either position or math function name) returns an individual member of the collection.  Note that VsaScalar and VsaVector do not share math functions.


Count Property

Get the number of math functions currently defined.

Applies To:	MathFuncs Object

Access:	Read only

Syntax:	Dim lngVal As Long
lngVal = objMathFuncs.Count

Remarks

The Count property is Read-only, and returns the number of individual items in the collection.


Item Property

Get the specified MathFunc object.

Applies To:	MathFuncs Object

Syntax:	Dim objMathFunc As MathFunc
Set objMathFunc = objMathFuncs.Item(vIndexKey)

Parameter	Data Type	Default Value	Description
vIndexKey	Variant	None	Gets specified item.
Remarks

Two properties help to manage every collection.  The default property, Item, returns a reference to an object in the collection.

The other property of every collection is the read-only Count property, which returns the number of objects in the collection.  The Count property can then be used to iterate through the collection.

The Item property has an index parameter, which may be a numeric index (1 is first Value) of the object in the collection.  For the ArbSources, Macros, or MathFuncs object, the index may also be a string key, which is the name of the object (see Name property)

See Also

Count Property

Name Property


SyntaxErrorPos Property

Get the position of the last error found by CheckSyntax

Applies To:	MathFuncs Object

Access:	Read only

Syntax:	Dim intVal As Integer
intVal = objMathFuncs.SyntaxErrorPos

Remarks

Returns the position within the string passed to the CheckSyntax method that contained an error.  Zero is returned if no errors were found on the last call to CheckSyntax.

See Also

CheckSyntax Method


CheckSyntax Method

Checks to see whether the text represents a valid math function

Applies To:	MathFuncs Object

Syntax:	objMathFuncs.CheckSyntax(sText)

Parameter	Data Type	Default Value	Description
sText	String	None	String that contains the entire math function
Remarks

The CheckSyntax method checks the syntax of math expression or VBScript macro passed as a parameter.  If a syntax error is found, an error is raised.

See Also

Check Syntax (Macros)

Check Syntax (Math)


NewMathFunc Method

Returns a new (created) MathFunc object.

Applies To:	MathFuncs Object

Syntax:	Dim objNewMathFunc As MathFunc
Set objNewMathFunc = objMathFuncs.NewMathFunc

Remarks

Returns a reference to a new empty math function.  The Text property sets the math function expression and the Name property changes the math function name.

See Also

New


RemoveAll Method

Remove all math functions

Applies To:	MathFuncs Object

Syntax:	objMathFuncs.RemoveAll

Remarks

The RemoveAll method removes all the MathFunc objects from the collection, and from persistent memory.


Measurement Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
AnalogDemod †	-->	Get the AnalogDemod object.
Average	-->	Get the Average object.
Calibration	-->	Get the Calibration object.
Continuous	RW	Get/set if the measurement is in continuous or single sweep mode.
DataRegs	-->	Get the DataRegs (data registers) object.
DemodConfig †	RW	Get/set the type of demodulation.
DigDemod †	-->	Get the DigDemod  (Digital Demodulation) object.
DigDemod1xEVDO †	-->	Get the DigDemod1xEVDO (1xEV-DO Demodulation) object.
DigDemod3G †	-->	Get the DigDemod3G  (3GPP and CDMA Digital Demodulation) object.
DigDemodDSSS †	-->	Get the DigDemodDSSS (WLAN-DSSS demodulation) object.
DigDemodOFDM †	-->	Get the DigDemodOFDM (OFDM demodulation) object.
DigDemodTDSCDMA †	-->	Get the DigDemodTDSCDMA (TDS-CDMA demodulation) object.
Frequency	-->	Get the Frequency object.
Hardware	-->	Get the Hardware object.
Inputs	-->	Get the Inputs object.
Source †	-->	Get the Source object.
Status	-->	Get the Status object.
Time †	-->	Get the Time object.
UpdateEnable	RW	Get/set if the measurement is updated after each change to the measurement setup.
Methods	Description
Continue	Continue the measurement.
Default	Default the measurement setup.
Disconnect	Pause the measurement and disconnect from the hardware.
Initialize	Initialize the measurement and acquire the measurement hardware.
Pause	Pause the measurement.
RecallFile	Recall the measurement state from a file.
Record †	Start recording the input data.
Reset	Stop the measurement.
SaveFile	Save the measurement state to a file.
Start	Start the measurement.
WaitForMeasDone	Wait for measurement to complete or timeout to occur before returning.
Remarks

The Measurement object represents the analyzer's measurement functionality.  It provides access to measurement control and to more specific objects that control a portion of the measurement setup.

Note that some properties of the measurement object are available only for the VsaVector application, including the Recording, Time, AnalogDemod, DigitalDemod objects, the DemodConfig property, and the Record method.

The Measurement state can be saved, recalled, and preset.  The measurement state consists of the properties of the measurement object and all sub-objects except the Hardware object, the Status object, the DataRegs object, the DigitalDemod constellation state definitions, and the UpdateEnable property.

Note that a setup saved with the VsaVector application cannot be recalled by the VsaScalar application (and Vice-versa).

See Also

Saving and Recalling Instrument Setups

Preset Setup

Control Menu


AnalogDemod Property

(Vector only)

Get the AnalogDemod object.

Applies To:	Measurement Object

Syntax:	Dim objAnalogDemod As AnalogDemod
Set objAnalogDemod = objMeasurement.AnalogDemod

Remarks

AnalogDemod (a property of the Measurement object) returns an AnalogDemod object.

See Also

AnalogDemod Object


Average Property

Get the Average object.

Applies To:	Measurement Object

Syntax:	Dim objAverage As Average
Set objAverage = objMeasurement.Average

Remarks

Average (a property of the Measurement object) returns an Average object.

See Also

Average Object


Calibration Property

Get the Calibration object.

Applies To:	Measurement Object

Syntax:	Dim objCalibration As Calibration
Set objCalibration = objMeasurement.Calibration

Remarks

Calibration (a property of the Measurement object) returns a Calibration object.

See Also

Calibration Object


Continuous Property

Get/set if the measurement is in continuous or single sweep mode.

Applies To:	Measurement Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objMeasurement.Continuous
objMeasurement.Continuous = blnVal

Remarks

True if sweep is continuous, False if single sweep.  Single sweep means that the measurement automatically pauses at the end of each sweep.

See Also

Setting up a Swept Measurement


DataRegs Property

Get the DataRegs (data registers) object.

Applies To:	Measurement Object

Syntax:	Dim objDataRegs As DataRegs
Set objDataRegs = objMeasurement.DataRegs

Remarks

DataRegs (a property of the Measurement object) returns a DataRegs object.

See Also

DataRegs Object


DemodConfig Property

(Vector only)

Get/set the type of demodulation.

Applies To:	Measurement Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaMeasDemodConfig
enumVal = objMeasurement.DemodConfig
objMeasurement.DemodConfig = enumVal

Remarks

Determine the type of demodulation applied by the current measurement, which may be off, analog demod, digital demod, cdma2000, or W-CDMA.  You need to set the DemodConfig property before setting any other measurement parameter as this affects the possible Values of Measurement frequency parameters and Trace.DataName, among other settings.

See Also

Demodulator

About Analog Demodulation

Setting up a Digital Demodulation Measurement


DigDemod Property

(Vector only)

Get the DigDemod  (Digital Demodulation) object.

Applies To:	Measurement Object

Syntax:	Dim objDigDemod As DigDemod
Set objDigDemod = objMeasurement.DigDemod

Remarks

DigDemod (a property of the Measurement object) returns a DigDemod object.

Note

Digital demodulation features are only available if Option AYA is installed.

See Also

DigDemod Object


DigDemod1xEVDO Property

(Vector only)

Get the DigDemod1xEVDO (1xEV-DO Demodulation) object.

Applies To:	Measurement Object

Syntax:	Dim objDigDemod1xEVDO As DigDemod1xEVDO
Set objDigDemod1xEVDO = objMeasurement.DigDemod1xEVDO

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


DigDemod3G Property

(Vector only)

Get the DigDemod3G  (3GPP and CDMA Digital Demodulation) object.

Applies To:	Measurement Object

Syntax:	Dim objDigDemod3G As DigDemod3G
Set objDigDemod3G = objMeasurement.DigDemod3G

Remarks

This property returns the DigDemod3G  object.


DigDemodDSSS Property

(Vector only)

Get the DigDemodDSSS (WLAN-DSSS demodulation) object.

Applies To:	Measurement Object

Syntax:	Dim objDigDemodDSSS As DigDemodDSSS
Set objDigDemodDSSS = objMeasurement.DigDemodDSSS

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


DigDemodOFDM Property

(Vector only)

Get the DigDemodOFDM (OFDM demodulation) object.

Applies To:	Measurement Object

Syntax:	Dim objDigDemodOFDM As DigDemodOFDM
Set objDigDemodOFDM = objMeasurement.DigDemodOFDM

Remarks

This property returns the DigDemodOFDM object.

See Also

DigDemodOFDM Object

MeasSetup->Demodulator->OFDM


DigDemodTDSCDMA Property

(Vector only)

Get the DigDemodTDSCDMA (TDS-CDMA demodulation) object.

Applies To:	Measurement Object

Syntax:	Dim objDigDemodTDSCDMA As DigDemodTDSCDMA
Set objDigDemodTDSCDMA = objMeasurement.DigDemodTDSCDMA

Remarks

To learn how this feature works, see online help for the dialog box that lets you set this parameter.


Frequency Property

Get the Frequency object.

Applies To:	Measurement Object

Syntax:	Dim objFrequency As Frequency
Set objFrequency = objMeasurement.Frequency

Remarks

Frequency (a property of the Measurement object) returns a Frequency object.

See Also

Frequency Object


Hardware Property

Get the Hardware object.

Applies To:	Measurement Object

Syntax:	Dim objHardware As Hardware
Set objHardware = objMeasurement.Hardware

Remarks

Hardware (a property of the Measurement object) returns a Hardware object.

See Also

Hardware Object


Inputs Property

Get the Inputs object.

Applies To:	Measurement Object

Syntax:	Dim objInputs As Inputs
Set objInputs = objMeasurement.Inputs

Remarks

Inputs (a property of the Measurement object),  returns an Inputs object.

See Also

Inputs Object


Source Property

(Vector only)

Get the Source object.

Applies To:	Measurement Object

Syntax:	Dim objSource As Source
Set objSource = objMeasurement.Source

Remarks

This property (a property of the Measurement object) returns the Source object.


Status Property

Get the Status object.

Applies To:	Measurement Object

Syntax:	Dim objStatus As Status
Set objStatus = objMeasurement.Status

Remarks

Status (a property of the Measurement object) returns a Status object.

See Also

Status Object

VsaVector / VsaScalar Objects


Time Property

(Vector only)

Get the Time object.

Applies To:	Measurement Object

Syntax:	Dim objTime As Time
Set objTime = objMeasurement.Time

Remarks

Time (a property of the Measurement object) returns a Time object.

See Also

Time Object


UpdateEnable Property

Get/set if the measurement is updated after each change to the measurement setup.

Applies To:	Measurement Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objMeasurement.UpdateEnable
objMeasurement.UpdateEnable = blnVal

Remarks

When you change a measurement parameter, the measurement is updated after each and every parameter change.  This can add significant overhead if you are programmatically making many changes.  Setting UpdateEnable False prevents the updates from happening until UpdateEnable is set to True.

There are some measurement changes for which UpdateEnable does not inhibit updates.  These include changes in DemodConfig, ChannelConfig, DataFrom, and Hardware changes.

Some parameter range limits are not enforced until UpdateEnable is set back to True.


Continue Method

Continue the measurement.

Applies To:	Measurement Object

Syntax:	objMeasurement.Continue

Remarks

The Continue method causes a paused measurement to continue.  The Start does the following that Continue does not:

•	restart averaging

•	reset the recording position to the start of playback

•	reset overlap processing

See Also

Pause/Single


Default Method

Default the measurement setup.

Applies To:	Measurement Object

Syntax:	objMeasurement.Default

Remarks

Application object
Sets the measurement setup, display appearance, menus/toolbars, and state definitions to their default Values.  This is the same as clicking File, Preset, Preset All from the application's main menu.

Display object
Sets the display appearance to its default Values.  This is the same as clicking File, Preset, Preset Display Appearance from the application's main menu.

Measurement object
Sets the measurement setup to its default Values.  This is the same as clicking File, Preset, Preset Setup from the application's main menu.

See Also

Preset All

Preset Display Appearance

Preset Setup

Presetting to a Known State


Disconnect Method

Pause the measurement and disconnect from the hardware.

Applies To:	Measurement Object

Syntax:	objMeasurement.Disconnect

Remarks

This method stops the measurement.  The measurement is stopped (if it is running) and does not communicate with the input channel hardware until the measurement is restarted.  The input channel hardware is reinitialized when the measurement is restarted, because the state of the hardware is now unknown.  This method is used if you want to access the input channel hardware directly.


Initialize Method

Initialize the measurement and acquire the measurement hardware.

Applies To:	Measurement Object

Syntax:	objMeasurement.Initialize

Remarks

This method needs to be called if you access the hardware outside of the VsaScalar / VsaVector applications and change any module's state.  This method forces the application to re-initialize the hardware before starting a measurement.


Pause Method

Pause the measurement.

Applies To:	Measurement Object

Syntax:	objMeasurement.Pause

Remarks

This method pauses the measurement, retaining all input data acquire.  The Reset method stops the measurement and clears the input data and all measurement result.  Either the Restart or Continue method can be used to get the measurement running again.

See Also

Pause/Single


RecallFile Method

Recall the measurement state from a file.

Applies To:	Measurement Object

Syntax:	objMeasurement.RecallFile(sFileName)

Parameter	Data Type	Default Value	Description
sFileName	String	None	The name of the file to recall.
Remarks

Recalls the measurement setup from the specified file


Record Method

(Vector only)

Start recording the input data.

Applies To:	Measurement Object

Syntax:	objMeasurement.Record

Remarks

This method stops the current measurement and starts a recording of the input data.  The VsaStatusBitRecording bit in the Status.Value property is cleared when the recording is finished.  This method also sets the Inputs.DataFrom property to VsaInpsDataFromRecording.

See Also

Record


Reset Method

Stop the measurement.

Applies To:	Measurement Object

Syntax:	objMeasurement.Reset

Remarks

Resets a measurement.  This stops a running measurement immediately and clears all measurement data.  You should use the Pause method instead of Reset if you want the stop the measurement at the end of the measurement loop and want to retain the measurement data.

See Also

Stop


SaveFile Method

Save the measurement state to a file.

Applies To:	Measurement Object

Syntax:	objMeasurement.SaveFile(sFileName)

Parameter	Data Type	Default Value	Description
sFileName	String	None	The name of the file to save to.
Remarks

This method Saves the measurement setup to the specified file.

Note that this method always saves trace and recording header information (which is optional when running the application manually). This means that if you wish to load the saved trace or recording into some other application, such as a database or some other signal analysis application, you will need to strip out the header information using a text editor.

See Also

Recall Display Appearance

Recall Setup


Start Method

Start the measurement.

Applies To:	Measurement Object

Syntax:	objMeasurement.Start

Remarks

The Start method causes a measurement in any state to restart.  The Start method does the following that Continue does not:

•	restart averaging

•	reset the recording position to the start of playback

•	reset overlap processing

See Also

Restart


WaitForMeasDone Method

Wait for measurement to complete or timeout to occur before returning.

Applies To:	Measurement Object

Syntax:	objMeasurement.WaitForMeasDone([timeOut])

Parameter	Data Type	Default Value	Description
timeOut	Long	10000	The number of milliseconds to wait before timing out.
Remarks

This method allows a macro or remote application to wait synchronously for a measurement to complete. If the call times out, the VsaErr_Data_Valid error condition is raised.

See Also

DigDemodOFDM Object

MeasSetup->Demodulator->OFDM


Recording Object

(Vector only)

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
PlayCenter †	R	Get the current recording center frequency.
PlayChannels †	R	Get the number of input channels in the current recording.
PlayDelay †	R	Get the trigger delay (in Sec) of the current recording.
PlayLoop †	RW	Get/set if playback of the recording will loop to the starting point when it reaches the stopping point.
PlayMaxSpan †	R	Get the cardinal frequency span of the current recording.
PlayPoints †	R	Get the number of points in the current recording.
PlaySampleRate †	R	Get the sample rate (in Samples/Sec) of the current recording.
PlaySpan †	R	Get the frequency span of the current recording.
PlayStart †	RW	Get/set the starting point of the recording playback.
PlayStop †	RW	Get/set the stopping point of the recording playback.
PlayZoom †	R	Get whether the current recording is zoomed.
Position †	RW	Get/set the current point of the recording playback.
RecLen †	R	Get the length of the next recording.
RecLenUnit †	R	Get the units of the length of the next recording.
RecMaxLen †	RW	Get/set if the recording length will be the maximum supported by the input channels.
RecSettle †	RW	Get/set if extra data will be acquired  to be able to settle the measurement filters during playback.
TempFile †	RW	Get/set the current (temporary) recording file name.
Trigger †	-->	Get the Trigger object.
Methods	Description
RecallFile †	Recall the current recording in the specified format from a file.
SaveFile †	Save the current recording in the specified format to a file.
SaveFileEx †	Save part of the current recording in the specified format to a file.
SetRecLen †	Set the length of the next recording.
Remarks

The Recording object represents the analyzer's recording and playback functionality.

Input data is recorded to a file using the Measurement.Record method.  The input data is acquired from the hardware inputs and is written to a current recording file.  Each new recording is written to this current recording file.  The TempFile property controls the location of this file on your computer.  The SaveFile method saves the current recording to a file in text format, MATLAB format, or SDF format (binary).  The RecallFile method recalls a file into the current recording, from which a measurement can be made.  The Inputs.DataFrom property is used to switch between measuring from input hardware and a recording.  Whenever a new recording is made with the Measurement.Record method, the recording is always made from the input hardware and then the Inputs.DataFrom is always switched to the current recording.

You can also control which part of the recording to supply to the measurement during playback and whether to repetitively loop the data to the measurement.

You can trigger the playback measurement by using the Recording.Trigger object.

The difference between a saved recording and a saved trace is that the recording contains the raw digital data, while saved traces represent all the filtering, demodulation, and other signal manipulation needed to re-construct a trace.  This means that you should decide in advance, the reason you are saving the data.  If you later want to re-construct the measurement, except perhaps, using a different demodulation technique, it would be best to save the digital data in the form of a recording.  Remember that you can also save the measurement state to facilitate recreating the conditions of the initial measurement.

The AgtVsaScalar application does not have a Recording object.

See Also

Recalling Recorded Data

Saving a Recording

Creating a Recording

Playback Trigger Tab

Input Menu

Recording Dialog Box


PlayCenter Property

(Vector only)

Get the current recording center frequency.

Applies To:	Recording Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objRecording.PlayCenter

Remarks

Returns the center frequency, in Hertz, of the current recording.  This corresponds to the analyzer's center frequency at the time the data was recorded.

See Also

Center


PlayChannels Property

(Vector only)

Get the number of input channels in the current recording.

Applies To:	Recording Object

Access:	Read only

Syntax:	Dim intVal As Integer
intVal = objRecording.PlayChannels

Remarks

Returns the number of input channels of data in the current recording.  This corresponds to the input channel configuration at the time the data was recorded.

Note that you can only play back a recording to a measurement with a channel configuration that has the same or fewer channels than the recording.

See Also

Channels


PlayDelay Property

(Vector only)

Get the trigger delay (in Sec) of the current recording.

Applies To:	Recording Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objRecording.PlayDelay

Remarks

The trigger delay of the recording is the same as the trigger delay of the inputs when the data was recorded.  The delay is zero if the trigger was freerun.

See Also

Delay


PlayLoop Property

(Vector only)

Get/set if playback of the recording will loop to the starting point when it reaches the stopping point.

Applies To:	Recording Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objRecording.PlayLoop
objRecording.PlayLoop = blnVal

Remarks

If this property is set to False, then the measurement pauses when it reaches the end of the recording.

See Also

Loop at end of Recording


PlayMaxSpan Property

(Vector only)

Get the cardinal frequency span of the current recording.

Applies To:	Recording Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objRecording.PlayMaxSpan

Remarks

Recordings may or may not be saved at the span used to create the recording.  If you save a recording using the SDF (fast) format, the recording is saved using the next higher cardinal span (cardinal spans are spans that are a power of 2).  If you save a recording using any other format, the recording is saved at its original span.

If you create a recording using a non-cardinal span and save it using the SDF (fast) format, the analyzer resamples the recording on playback to play it back at its non-cardinal span.  Since the recording was saved at the next higher cardinal span, you can change the span up to that value.

The PlaySpan and PlayMaxSpan properties return the span (in Hertz) that was used to create the recording (PlaySpan) or the cardinal span used to save the recording (PlayMaxSpan).  If you used a cardinal span to create the recording, PlaySpan and PlayMaxSpan will be identical.

Note

The value of PlaySpan and PlayMaxSpan are identical for all recordings except SDF (fast).  For SDF (fast) recordings, PlaySpan and PlayMaxSpan are identical only if the recording was created using a cardinal span.


PlayPoints Property

(Vector only)

Get the number of points in the current recording.

Applies To:	Recording Object

Access:	Read only

Syntax:	Dim lngVal As Long
lngVal = objRecording.PlayPoints

Remarks

Returns the number of input points contained in the current recording that are available to a measurement.  This Value defines the upper limit to the PlayStart and PlayStop properties.

See Also

Length


PlaySampleRate Property

(Vector only)

Get the sample rate (in Samples/Sec) of the current recording.

Applies To:	Recording Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objRecording.PlaySampleRate

Remarks

Returns the sample rate of the data in the current recording.  You can use this property along with the PlayPoints property to determine the length, in seconds, of the recording.


PlaySpan Property

(Vector only)

Get the frequency span of the current recording.

Applies To:	Recording Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objRecording.PlaySpan

Remarks

Returns the frequency span, in Hertz, of the current recording.

See Also

Span


PlayStart Property

(Vector only)

Get/set the starting point of the recording playback.

Applies To:	Recording Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objRecording.PlayStart
objRecording.PlayStart = lngVal

Remarks

Determine the point within the current recording at which playback of the recording starts.  When you restart the measurement (with Measurement.Start), the current playback position (Position property) is set to the Value of PlayStart.  The PlayStop property determines when you reach the end of recording data. ). The PlayStart point is determined by the following calculation:
 PlayStart point = (Start time - Delay time) x SampleRate.

The PlayStart property is reset to the beginning of the recording when you record new data, recall a recording, or enter playback mode (set Inputs.DataFrom to VsaInpsDataFromRecording)

See Also

Start Time

PlayStop Property

PlayLoop Property

Position Property


PlayStop Property

(Vector only)

Get/set the stopping point of the recording playback.

Applies To:	Recording Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objRecording.PlayStop
objRecording.PlayStop = lngVal

Remarks

Determine the point within the current recording at which playback of the recording stops. When the measurement position (Position property) reaches PlayStop, the measurement either pauses or loops to the PlayStart position, depending upon the state of the PlayLoop property The PlayStop point is determined by the following calculation:
 PlayStop point = (Stop time - Delay time) x SampleRate.

The PlayStop property is reset to the end of the recording when you record new data, recall a recording, or enter playback mode (set Inputs.DataFrom to VsaInpsDataFromRecording).

See Also

Stop Time

PlayStart Property

PlayLoop Property

Position Property


PlayZoom Property

(Vector only)

Get whether the current recording is zoomed.

Applies To:	Recording Object

Access:	Read only

Syntax:	Dim blnVal As Boolean
blnVal = objRecording.PlayZoom

Remarks

Returns whether the input was zoomed when the current recording was made.

See Also

Time Data


Position Property

(Vector only)

Get/set the current point of the recording playback.

Applies To:	Recording Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objRecording.Position
objRecording.Position = lngVal

Remarks

Determine in units of points the data location in the recording at which play back into the measurement will occur. The position is relative to the beginning of the recording (0 is first point). The Position point is determined by the following calculation:
 Position point = (Position time - Delay time) x SampleRate.

When you restart the measurement (with Measurement.Start), the Position is set to the Value of PlayStart.  When the Position reaches the end of the recording data (PlayStop property), the measurement either pauses or loops to the PlayStart position, depending upon the state of the PlayLoop property.

The Position property is reset to the beginning of the recording when you record new data, recall a recording, or enter playback mode (set Inputs.DataFrom to VsaInpsDataFromRecording).

See Also

PlayStart Property

PlayStop Property

PlayLoop Property

Start Time


RecLen Property

(Vector only)

Get the length of the next recording.

Applies To:	Recording Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objRecording.RecLen

Remarks

The RecLenUnit property returns the unit of the length, either record, point, or second.  The SetRecLen method sets both the record length and the unit.

See Also

Length

RecLenUnit Property

SetRecLen Method


RecLenUnit Property

(Vector only)

Get the units of the length of the next recording.

Applies To:	Recording Object

Access:	Read only

Syntax:	Dim enumVal As VsaRecLenUnit
enumVal = objRecording.RecLenUnit

Remarks

The RecLen property returns the length of the next recording.  The SetRecLen method sets both the record length and the unit.

See Also

Length

RecLen Property

SetRecLen Property


RecMaxLen Property

(Vector only)

Get/set if the recording length will be the maximum supported by the input channels.

Applies To:	Recording Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objRecording.RecMaxLen
objRecording.RecMaxLen = blnVal

Remarks

The maximum recording length supported by the input channels depends upon the following:

•	amount of memory installed in the ADC,

•	the current span (affects size of a data point),

•	whether you are in zoom mode,

•	whether the span is a cardinal span (directly supported by the hardware) or resampled span (supported by the measurement software).

See Also

Max Length


RecSettle Property

(Vector only)

Get/set if extra data will be acquired  to be able to settle the measurement filters during playback.

Applies To:	Recording Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objRecording.RecSettle
objRecording.RecSettle = blnVal

Remarks

If this property is True, then the recording length that you can play back is exactly what you specified.  If you set its property to False, then when the data is played back, some of the data will be used to settle the measurement filters and you won't see it in the measurement results.

See Also

Extra to settle filters


TempFile Property

(Vector only)

Get/set the current (temporary) recording file name.

Applies To:	Recording Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objRecording.TempFile
objRecording.TempFile = strVal

Remarks

Determine the path and file name of the temporary recording file.  Whenever you record data or recall a recording, this file is overwritten.  It contains data of a temporary nature.  Use the SaveFile method to save your recording more permanently.  The TempFile grows to the size of the current recording.  This method exists so that you can move the current recording to another drive if this drive does not have enough space.

See Also

Temporary File


Trigger Property

(Vector only)

Get the Trigger object.

Applies To:	Recording Object

Syntax:	Dim objTrigger As Trigger
Set objTrigger = objRecording.Trigger

Remarks

Trigger (a property of both the Inputs and Recording objects) returns a Trigger object.

See Also

Trigger Object


RecallFile Method

(Vector only)

Recall the current recording in the specified format from a file.

Applies To:	Recording Object

Syntax:	objRecording.RecallFile(sName, sFmt)

Parameter	Data Type	Default Value	Description
sName	String	None	The name of the file to recall.
sFmt	String	None	The file format.
Remarks

Recalls the recording from the specified file.  The current recording, in SDF format, is persisted as a file determined by the TempFile property.  The file format selection is the same as in the DataReg.RecallFile method.

See Also

Recall Recording


SaveFile Method

(Vector only)

Save the current recording in the specified format to a file.

Applies To:	Recording Object

Syntax:	objRecording.SaveFile(sName, [sFmt], [bHdr])

Parameter	Data Type	Default Value	Description
sName	String	None	The name of the file to save to.
sFmt	String		The file format.
bHdr	Boolean	True	Flag that determines whether the data header is saved with the data.  True includes the data header, False does not.
Remarks

Saves the recording to the specified file.  The file format selection is the same as in the Trace.SaveFile method.

If the bHdr parameter is False, then the recording header is not saved with the recording.  This means if you recall the recording back into the instrument, the time parameters for the data will not be restored.

Note that this method always saves trace and recording header information (which is optional when running the application manually). This means that if you wish to load the saved trace or recording into some other application, such as a database or some other signal analysis application, you will need to strip out the header information using a text editor.

See Also

Recall Recording


SaveFileEx Method

(Vector only)

Save part of the current recording in the specified format to a file.

Applies To:	Recording Object

Syntax:	objRecording.SaveFileEx(sName, sFmt, bHdr, bMeasFreq, bPlayTime)

Parameter	Data Type	Default Value	Description
sName	String	None
sFmt	String	None
bHdr	Boolean	None
bMeasFreq	Boolean	None
bPlayTime	Boolean	None
Remarks

To learn how this feature works, see online help for the dialog box that lets you execute this function.


SetRecLen Method

(Vector only)

Set the length of the next recording.

Applies To:	Recording Object

Syntax:	objRecording.SetRecLen(dLen, eUnit)

Parameter	Data Type	Default Value	Description
dLen	Double	None	The length of  the recording.
eUnit	VsaRecLenUnit	None	The units for the recording length: seconds, points, or records.
Remarks

This method sets the length of the next recording.  If the RecMaxLen property is set to True, then the recording length is set to the largest size that the inputs will support.  This is limited by the amount of memory installed in the input channel modules.

See Also

Max. Length


Source Object

(Vector only)

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Amplitude †	RW	Gets/sets the source power in dBm.
ArbSources †	-->	Returns the ArbSources object.
Enable †	RW	Gets/sets if source control is enabled.
Frequency †	RW	Gets/sets the source carrier frequency in Hz.
OffsetFrequency †	RW	Get/set the offset between the source and analyzer frequencies for Track Frequency mode.
Step †	RW	Get/set the step used for incremental source frequency changes
StepAuto †	RW	Get/set whether the source frequency step is fixed or automatically determined
Style †	RW	Gets/sets the source style.
TrackFrequency †	RW	Get/set whether source frequency tracks analyzer frequency changes
Remarks

The Source Object allow basic control of a hardware source. The primary purpose is to allow the user to record signals with the analyzer and play them back through the source by the use of arbitrary, complex modulation. The source may also be set to output a continuous sine wave. The ArbSources property provides access to the record/playback capabilities while the other properties control basic functions. While the Style property is vsaSourceStyleOff, no commands are sent to the source by the analyzer. Thus the source may be controlled by the user by other means in order to access more advanced capabilities.


Amplitude Property

(Vector only)

Gets/sets the source power in dBm.

Applies To:	Source Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objSource.Amplitude
objSource.Amplitude = dblVal

Remarks

Determines or sets the source power when it is producing a sine wave. The value is in dBm. Note that this is different from the Range, which is in Volts (peak). If the value is set above or below the limits of the source hardware, the source is set to the limiting value. You may then read back the actual value to which the source was set.

The amplitude of the source will be less when reproducing an arbitrary waveform. In addition, the amplitude of the played-back waveform will probably differ from the amplitude of the recorded waveform.


ArbSources Property

(Vector only)

Returns the ArbSources object.

Applies To:	Source Object

Syntax:	Dim objArbSources As ArbSources
Set objArbSources = objSource.ArbSources

Remarks

ArbSources (a property of the Source object) returns a ArbSources object.


Enable Property

(Vector only)

Gets/sets if source control is enabled.

Applies To:	Source Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objSource.Enable
objSource.Enable = blnVal

Remarks

The Source Enable property enables or disables communication with the external, signal source hardware. When False, the source may be operated manually or by other remote control applications. When True, the source is reset and then set to the state reflected in the properties of the Source object. The default state is False when the program starts.


Frequency Property

(Vector only)

Gets/sets the source carrier frequency in Hz.

Applies To:	Source Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objSource.Frequency
objSource.Frequency = dblVal

Remarks

Frequency (a property of the Measurement object) returns a Frequency object.

See Also

Frequency Object


OffsetFrequency Property

(Vector only)

Get/set the offset between the source and analyzer frequencies for Track Frequency mode.

Applies To:	Source Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objSource.OffsetFrequency
objSource.OffsetFrequency = dblVal

Remarks

This property is only used when source Track Frequency is on (TrackFrequency is True).  When source Track Frequency is on, changing the analyzer's center frequency also changes the source's center frequency, as follows:

(Source Center Frequency) = (Analyzer Center Frequency) + (OffsetFrequency)

OffsetFrequency can be a positive or negative value.  If the new source center-frequency would exceed that supported by the source, the value of OffsetFrequency is automatically changed, as follows:

(OffsetFrequency) = (Maximum Source Center Frequency) − (Analyzer Center Frequency)

See Also

TrackFrequency Property


Step Property

(Vector only)

Get/set the step used for incremental source frequency changes

Applies To:	Source Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objSource.Step
objSource.Step = dblVal

Remarks

Even though you can set the Step property programmatically, you can only use it to step the frequency values through the user interface using the arrow key or mouse wheel.  This property is not used if the StepAuto property is set to True.

See Also

Frequency Step

StepAuto Property


StepAuto Property

(Vector only)

Get/set whether the source frequency step is fixed or automatically determined

Applies To:	Source Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objSource.StepAuto
objSource.StepAuto = blnVal

Remarks

If StepAuto is set to False, then the frequency step is determined by the Step property.

If StepAuto is set to True, then:

•	span follows 1-2-5 steps and speed optimized spans

•	center frequency follows (span / 10) steps

•	start frequency follows 1-2-5 steps

See Also

Auto Frequency Step

Step Property


Style Property

(Vector only)

Gets/sets the source style.

Applies To:	Source Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaSrcStyle
enumVal = objSource.Style
objSource.Style = enumVal

Remarks

Determines the source style. The possible styles are tabulated below:

Constant	Meaning
vsaSrcStyleOff	When selected, the source RF output is turned off.
vsaSrcStyleSine	When selected, the source produces a sine wave output.
vsaSrcStyleArb	When selected, the source produces a sine wave modulated by complex data stored in the active ArbSource object.


TrackFrequency Property

(Vector only)

Get/set whether source frequency tracks analyzer frequency changes

Applies To:	Source Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objSource.TrackFrequency
objSource.TrackFrequency = blnVal

Remarks

When set to True, this property causes the source to track changes in the analyzer's center frequency.  When set to False, changing the analyzer's center frequency does not affect the source's center frequency.

When you set TrackFrequency to True, the source's center frequency is changed (if necessary) to maintain the offset specified by the OffsetFrequency Property.  This offset is maintained for any changes in the analyzer's center frequency.

See Also

OffsetFrequency Property


Spectrogram Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
ColorCount	RW	Get/set the number of amplitude color levels for the spectrogram.
ColorMap	RW	Get/set how to map amplitude values to colors.
Count	R	Get the number of scans in the current spectrogram.
DataAtScan	R	Get the raw data at the specified scan index.
Enhance	RW	Get/set the color enhancement factor, which affects the distribution of colors in the spectrogram.
MapColorData	R	Get the colors for the current color map in the specified number format.
MaxCount	RW	Get/set the maximum number of scans in the spectrogram for this trace.
ScanAtTime	R	Get the scan index that is closest to the specified scan time (in sec).
Threshold	RW	Get/set the threshold, which affects the minimum amplitude value that will be shown in the spectrogram.
TimeAtScan	R	Get the scan time (in sec) at the specified scan index.
Visible	RW	Get/set if the spectrogram data is acquired and displayed.
Remarks

The Spectrogram object gives you access to spectrogram displays.  Use this object to configure and View spectrogram displays.


ColorCount Property

Get/set the number of amplitude color levels for the spectrogram.

Applies To:	Spectrogram Object

Access:	Read/Write

Syntax:	Dim intVal As Integer
intVal = objSpectrogram.ColorCount
objSpectrogram.ColorCount = intVal

Remarks

The ColorCount property returns the number of color indexes available to the Color property and the IsColorByTrace property.  Each color index identifies a displayed portion of the trace.

See Also

Color Tab

IsColorByTrace Property


ColorMap Property

Get/set how to map amplitude values to colors.

Applies To:	Spectrogram Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaSpcClrMap
enumVal = objSpectrogram.ColorMap
objSpectrogram.ColorMap = enumVal

Remarks

This property sets or gets the scheme of mapping colors in the spectrogram.  You can specify a normal or reverse, color or grey map, or you can specify a user color map.

See Also

Map Color Scheme


Count Property

Get the number of scans in the current spectrogram.

Applies To:	Spectrogram Object

Access:	Read only

Syntax:	Dim lngVal As Long
lngVal = objSpectrogram.Count

Remarks

Used with the Spectrogram object, the Count property returns the number of scans of data that are contained in the current spectrogram.  It can be between 0 and Spectrogram.MaxCount.  The spectrogram is emptied when you turn spectrogram off (Spectrogram.Visible = False) and when you start (not continue) a measurement (Measurement.Start).  You can use the Spectrogram.DataAtScan property to get the raw (possibly complex) data for each scan in the spectrogram.


DataAtScan Property

Get the raw data at the specified scan index.

Applies To:	Spectrogram Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objSpectrogram.DataAtScan(iScan, vType)

Parameter	Data Type	Default Value	Description
iScan	Long	None	Integer that represents a single scan in a spectrogram display.
vType	Integer	None	Data type for the array elements returned by this property.
Remarks

This property returns the raw (possibly complex data) at the specified spectrogram scan.  You can specify the data type of the elements of the returned array, which can be vbSingle (4), vbDouble (5), or vbVariant (12).  All scans have the same format as the Trace.RawData, which contains the data for the current scan.

See Also

RawDataComplex Property

RawDataPoints Property

RawData Property


Enhance Property

Get/set the color enhancement factor, which affects the distribution of colors in the spectrogram.

Applies To:	Spectrogram Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objSpectrogram.Enhance
objSpectrogram.Enhance = dblVal

Remarks

This property sets or gets the spectrogram color enhancement.  It is a value between 0 and 100.

See Also

Enhance Parameter


MapColorData Property

Get the colors for the current color map in the specified number format.

Applies To:	Spectrogram Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objSpectrogram.MapColorData(vType)

Parameter	Data Type	Default Value	Description
vType	Integer	None	Data type of the elements in the returned array.
Remarks

This property returns an array that contains all the RGB colors in the current spectrogram color map.  The user can specify the data type of the elements of the returned array, which can be vbLong (3), vbSingle (4), vbDouble (5), or vbVariant (12).

See Also

User Map Color Tab

MapUserColorCount Property

MapUserColor Property

MapUserColorData Property

MapUserColorDataSet Method

MapUserColorMaxCount Property


MaxCount Property

Get/set the maximum number of scans in the spectrogram for this trace.

Applies To:	Spectrogram Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objSpectrogram.MaxCount
objSpectrogram.MaxCount = lngVal

Remarks

This property sets or gets the maximum number of scans of data that are contained in the spectrogram.  The maximum value is limited by the amount of memory in your computer.  The spectrogram memory is used to:

•	Refresh the spectrogram when you change trace properties.

•	Save the spectrogram when you save the data to a file.

•	Read the data when you access data on a specified scan.

See Also

DataAtScan Property

Buffer Depth


ScanAtTime Property

Get the scan index that is closest to the specified scan time (in sec).

Applies To:	Spectrogram Object

Access:	Read only

Syntax:	Dim lngVal As Long
lngVal = objSpectrogram.ScanAtTime(dSec)

Parameter	Data Type	Default Value	Description
dSec	Double	None	Time offset, in seconds.
Remarks

Each scan in a spectrogram is tagged with the time of its acquisition relative to Measurement.Start (in seconds).  This property returns the index of the nearest scan to the specified time offset (in seconds).

See Also

TimeAtScan Property

DataAtScan Property


Threshold Property

Get/set the threshold, which affects the minimum amplitude value that will be shown in the spectrogram.

Applies To:	Spectrogram Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objSpectrogram.Threshold
objSpectrogram.Threshold = dblVal

Remarks

This property sets or gets the spectrogram color threshold.  It is a value between 0 and 100.

See Also

Threshold


TimeAtScan Property

Get the scan time (in sec) at the specified scan index.

Applies To:	Spectrogram Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objSpectrogram.TimeAtScan(iScan)

Parameter	Data Type	Default Value	Description
iScan	Long	None	An index (integer) that represents a single scan in a spectrogram display.
Remarks

Each scan in a spectrogram is tagged with the time of its acquisition relative to the Measurement.Start (in seconds).  This property returns the time offset (in seconds) of the specified scan.

See Also

ScanAtTime Property

DataAtScan Property


Visible Property

Get/set if the spectrogram data is acquired and displayed.

Applies To:	Spectrogram Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objSpectrogram.Visible
objSpectrogram.Visible = blnVal

Remarks

It is useful to hide the analyzer window if you are programming and do not need to see any displayed data or do not want a user to access the analyzer's user interface.

When you create the application object programmatically, Visible is defaulted to False.  If you start the application from a user interface, Visible is defaulted to True.

For the spectrogram object, this property sets or gets whether the spectrogram is turned on (TRUE = on, FALSE = off).  The data in the spectrogram is cleared when the spectrogram is turned off.


Status Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
EventName	RW	Get/set the name of a win32 Event object to SetEvent() when any of the masked events occur.
MeasError	R	Returns the last measurement error that has occurred & clears the error.
NegativeEventSum	R	Get the sum of all masked negative events that have occured since the last time this property was called.
NegativeMask	RW	Get/set the status bits for which a negative transition will cause an event to fire.
PositiveEventSum	R	Get the sum of all masked positive events that have occured since the last time this property was called.
PositiveMask	RW	Get/set the status bits for which a positive transition will cause an event to fire.
Value	R	Get the current status events value.
Events	Description
MeasErrorEvent	Raised when a measurement error has occured.
NegativeEvent	Raised when the status associated with any non-zero bit in the NegativeMask changes.
PositiveEvent	Raised when the status associated with any non-zero bit in the PositiveMask changes.
Remarks

The Status object provides information about the analyzer's status.  There are up to 32 bits of status information encoded in a long Value.  You can determine if a measurement is running and where it is in the measurement loop, whether a calibration is running or is needed, and whether a recording is in progress.

The Status Model

The following diagram shows how the COM API generates status and error messages.  The sections after the diagram explain how to monitor status and error messages and also contain descriptions of each status bit.

Monitoring Status Bits

Status bits are set as the appropriate condition occurs and are cleared as soon as the condition disappears.  The current status can be determined by reading the Value property.  Many times, you don't need to know the current Value of a status bit, but want to know if at least one transition in the bit has occurred.  You can catch these transitions by setting up a PositiveMask (0 to 1 transition of a bit) or a NegativeMask (1 to 0 transition of a bit).  When an unmasked bit transition occurs, it is latched into the PositiveEventSum or NegativeEventSum property.

Your program can determine the status in one of three ways:

1.	You can poll the Status object in a loop in your program.  If you do this, you should Sleep() in between calls to get status, so that the analyzer does not spend its entire time servicing status requests.  You can poll the Value, PositiveEventSum, NegativeEventSum, and MeasError properties in your loop.  All these properties except for Value are cleared after they are read.  This is the only way of checking status from a macro.

2.	You can respond to events.  Note that you cannot read the Status Value within the event handler.  Attempting to do so causes a deadlock.

In VB, you declare the status Variable with events and set a reference to the Status object.

Dim oApp as AgtVsaVector.Application

Dim WithEvents oStat As AgtVsaVector.Status

...

Set oApp = New AgtVsaVector.Application

Set oStat = oApp.Measurement.Status

...

Sub oStat_PositiveEvent(ByVal newStatus As AgtVsaVector.VsaStatusBits)

    If newStatus And VsaStatusAvgComp then

' code to execute when average is complete

    End If

End Sub

Sub oStat_NegativeEvent(ByVal newStatus As AgtVsaVector.VsaStatusBits)

    If newStatus And VsaStatusBitWaitTrig then

' code to execute when trigger occurs

    End If

End Sub

You then will have 3 events available to you: PositiveEvent, NegativeEvent, and MeasErrorEvent.  The positive/negative events are raised when a status bit changes in the appropriate register that is unmasked.  The MeasErrorEvent is raised when a measurement encounters an error condition.

3.	You can respond to a win32 event object.  This is most useful in a C/C++ program because COM event handlers are more difficult to write in C/C++ than in VB.  In your program, you create a named event with the CreateEvent() win32 function and then use the EventName property to connect that event to the analyzer.  The win32 event is set (via SetEvent) when an unmasked positive/negative event is raised, or a measurement error is raised.  When you receive the event, you must still poll the status object to determine the cause of the event.

Tip

The Agilent\89600 VSA\Examples\vb\StatusDemo directory contains a sample Visual BASIC program that shows you how to use the Status object to determine the analyzer's status.

VsaStatusBit Definitions

In the following descriptions of the VsaStatusBits, a scan is defined as one data acquisition, calculation, and display sequence in the measurement loop:

Status Bit	Description
vsaStatusBitNone	This bit is no longer used and is here for backward compatibility only.  The value of this bit is always zero.
vsaStatusBitMeasDone	This bit is set at the end of the measurement if the measurement stops.  This occurs at the end of a single sweep and when a stable averaged measurement stops because the number of averages is reached.  This bit is cleared when a measurement starts.
vsaStatusBitCalibrating	This bit is set when a calibration starts, and is cleared when a calibration finishes.
vsaStatusBitAcquiring	This bit is set when the analyzer is waiting to acquire data (for example, when the analyzer is waiting for trigger).  It is reset when the data has been acquired.  For Vector measurements, this bit toggles for every measurement average.  For Scalar measurements, this bit toggles for every sweep segment.
vsaStatusBitSettling	This bit is set when the measurement is acquiring data to settle the measurement filters.  This only occurs after a measurement restart and is cleared when enough data is acquired to settle the filters.
vsaStatusBitWaitPreTrig	This bit is set during acquisition when the measurement is set to be triggered, a pre-trigger delay has been specified, the trigger has been enabled, and the pre-trigger delay has not yet been satisfied.  This bit is cleared when the pre-trigger delay has been satisfied.  This bit is set only once per scan.
vsaStatusBitWaitTrig	This bit is set during acquisition when the measurement is set to be triggered, the trigger has been enabled, but a Valid trigger condition has not yet been received.  This bit is cleared when the trigger occurs.  This bit is set only once per scan.
vsaStatusBitReadingData	This bit is only used with the Vector Signal Analyzer application; it is not used with the Spectrum Analyzer application.  When running the Vector Signal Analyzer application, this bit is set during acquisition when the measurement is reading data from the input hardware.  This bit is cleared when the data has been read.  This bit may be pulsed multiple times during acquisition of data if the measurement is settling.
vsaStatusBitRecording	This bit is set when a recording is started and cleared when a recording is finished.
vsaStatusBitAvgComp	This bit is set for each scan where the measurement data represents a complete average.  This bit is cleared for each scan where the measurement data is averaged, but does not represent a complete average.  If the measurement is not averaged, this bit is not changed.  A complete average is accomplished when the number of averages is satisfied.
vsaStatusBitSyncNotFound	This bit is cleared at the beginning of each scan in a digital demod measurement.  The bit is set if the sync search pattern is not found at the end of each scan.  If sync search is off or this is not a digital demod measurement, then this bit is cleared.
vsaStatusBitPulseNotFound	This bit is cleared at the beginning of each scan in a digital demod measurement.  The bit is set if a pulse is not found at the end of each scan.   If pulse search is off or this is not a digital demod measurement, then this bit is cleared.
vsaStatusBitCalNeeded	This bit is set when the current hardware needs to be calibrated to guarantee measurement specifications.  This bit is cleared after a successful calibration with the current hardware.
vsaStatusBitCalWarmUp	This bit is set after the current hardware is changed and the hardware temperature is not yet stable.  This bit is cleared when the hardware temperature becomes stable.
vsaStatusBitExtRefLock	This bit is set when the current hardware locks to an external reference signal (the application displays "EXT REF" in the status bar).  This bit is valid only for hardware configurations that support the use of an external reference signal.
vsaStatusBitIntRefLock	This bit is set when the current hardware locks to the system reference  (regardless of whether it is an internal or external reference).
vsaStatusBitGapData	This bit indicates that there is a gap between current data and previous data. A gap between data indicates either that you are not in real time or, if you are playing a recording, that you have looped from the end to the beginning of the file or moved the play position.
vsaStatusBitEndData	This bit occurs when you are playing back a recording and the measurement has paused because you have arrived at the end of the recorded data; this bit is cleared on the next measurement.
vsaStatusBitMeasuring	This bit is set when the measurement is running and cleared anytime the measurement pauses or stops for any reason.
•


EventName Property

Get/set the name of a win32 Event object to SetEvent() when any of the masked events occur.

Applies To:	Status Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objStatus.EventName
objStatus.EventName = strVal

Remarks

This property is provided as an aid in programming applications in C/C++. The OLE event mechanism is easy enough to implement in Visual Basic, but can be cumbersome if you are programming in C/C++.

In your program, you create a named event with the CreateEvent() win32 function and then use the EventName property to connect that event to the analyzer.  The win32 event is set (via SetEvent) in the analyzer when an unmasked positive/negative event is raised, or a measurement error is raised.  When you receive the event, you must still poll the status object to determine the cause of the event.  You can get the PositiveEventSum, NegativeEventSum, and MeasError properties to determine which events happened.  These properties are cleared after they are read.

Refer to the CreateEvent() win32 function in your programming documentation for further details.

See Also

Status Object


MeasError Property

Returns the last measurement error that has occurred & clears the error.

Applies To:	Status Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objStatus.MeasError

Remarks

Returns a string representing the last measurement error and clears the error.  If no error has occurred, then the string is empty.  The measurement error can also be determined from the event MeasErrorEvent.


NegativeEventSum Property

Get the sum of all masked negative events that have occured since the last time this property was called.

Applies To:	Status Object

Access:	Read only

Syntax:	Dim enumVal As VsaStatusBits
enumVal = objStatus.NegativeEventSum

Remarks

Reading the NegativeEventSum property returns a number that corresponds to the summation of all the status bits (unmasked Via the NegativeMask property) experiencing negative transitions since the property was last read. Reading the property clears the bits.

See Also

Status Object

NegativeMask Property

PositiveEventSum Property


NegativeMask Property

Get/set the status bits for which a negative transition will cause an event to fire.

Applies To:	Status Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaStatusBits
enumVal = objStatus.NegativeMask
objStatus.NegativeMask = enumVal

Remarks

Establishes a mask that determines which negative transitions (in the status bits) raise an event.  The NegativeMask property also determines which status bits are summed into the NegativeEventSum property. Use a 1 (one) to include (unmask) a status bit; use a 0 (zero) to exclude (mask) a status bit.

For example, to create a mask that determines if the analyzer has received a trigger signal, set the NegativeMask property to the Value of the constant VsaStatusBitWaitTrig (decimal 32, hex 20).  Decimal 32 is the Value (location) of the VsaStatusBitWaitTrig bit in the status register (binary 100000).  The status bit is set to one when the measurement is waiting for a trigger, and transitions from high to low (one to zero) when the trigger occurs.  Because the corresponding bit is set in the NegativeMask, the same bit is set in the NegativeEventSum property and the NegativeEvent is fired.

You can determine when status bits become cleared by polling the NegativeEventSum property or by setting up an event handler for the NegativeEvent.  You normally use the negative event to find out when something finishes (e.g. calibration or recording has finished).

The status bits are described in the topic for the Status Object.

See Also

Status Object

NegativeEventSum Property

NegativeEvent Event

PositiveMask Property


PositiveEventSum Property

Get the sum of all masked positive events that have occured since the last time this property was called.

Applies To:	Status Object

Access:	Read only

Syntax:	Dim enumVal As VsaStatusBits
enumVal = objStatus.PositiveEventSum

Remarks

Reading the PositiveEventSum property returns a number that corresponds to the summation of all the status bits (unmasked Via the PositiveMask property) experiencing positive transitions since the property was read last. Reading the property clears the bits.

See Also

Status Object

PositiveMask Property

NegativeEventSum Property


PositiveMask Property

Get/set the status bits for which a positive transition will cause an event to fire.

Applies To:	Status Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaStatusBits
enumVal = objStatus.PositiveMask
objStatus.PositiveMask = enumVal

Remarks

Establishes a mask that determines which positive transitions (in the status bits) raise an event.  The PositiveMask property also determines which status bits are summed into the PositiveEventSum property.  Use a 1 (one) to include (unmask) a status bit; use a 0 (zero) to exclude (mask) a status bit.

For example, to create a mask that determines if the analyzer is waiting for a trigger signal, set the PositiveMask property to the Value of the constant VsaStatusBitWaitTrig (decimal 32, hex 20).  Decimal 32 is the Value (location) of the VsaStatusBitWaitTrig bit in the status register (binary 100000).  The status bit transitions from low to high (zero to one) when the measurement is set to be triggered, the trigger has been enabled, but a Valid trigger condition has not yet been received (the bit is cleared when the trigger occurs).  Because the corresponding bit is set in the PositiveMask, the same bit is also set in the PositiveEventSum property and the PositiveEvent if fired.

You can determine when status bits become set by polling the PositiveEventSum property or by setting up an event handler for the PositiveEvent.  You normally use the PositiveEvent to determine when something starts (e.g. calibration or recording has started), or when a set bit indicates a completion of some type (e.g. end of measurement).

The status bits are described in the topic for the Status Object.

See Also

Status Object

PositiveEventSum Property

PositiveEvent Event

NegativeMask Property


Value Property

Get the current status events value.

Applies To:	Status Object

Access:	Read only

Syntax:	Dim enumVal As VsaStatusBits
enumVal = objStatus.Value

Remarks

Returns the current Value of all measurement status bits.  Typically, you use the status Value to determine the following:

•	Measurement is in progress

•	Calibration is in progress

•	Recording is in progress

The measurement, calibration, and recording status bits are not as dynamic as other status bits and are easily monitored by looking at the status Value. Other status bits may transition several times during a measurement and should be checked using status masks and status events instead of the status Value.

Note

There are internal, undocumented status bits that also affect the status Value.  The internal status bits may be a one or zero.  Therefore, make sure you mask the status Value to exclude all bits except those you are interested in.

For further details about status bits, see help for the Status Object.


MeasErrorEvent Event

Raised when a measurement error has occured.

Applies To:	Status Object

Syntax:	Dim WithEvents objStatus As Status
Set objStatus = Status
Sub objStatus_MeasErrorEvent(ByVal sErrMsg As String)
  ...
End Sub

Parameter	Data Type	Default Value	Description
sErrMsg	String	None	A string that indicates the error that occurred.
Remarks

This event is raised when a measurement error condition is encountered.  The sErrMsg parameter indicates which error happened.

Note that you cannot read the Status Value during the event.


NegativeEvent Event

Raised when the status associated with any non-zero bit in the NegativeMask changes.

Applies To:	Status Object

Syntax:	Dim WithEvents objStatus As Status
Set objStatus = Status
Sub objStatus_NegativeEvent(ByVal newStatus As VsaStatusBits)
  ...
End Sub

Parameter	Data Type	Default Value	Description
newStatus	VsaStatusBits	None	A constant that specifies the status bit or bits that were unmasked.
Remarks

This event is raised when a status bit associated with any non-zero bit in the NegativeMask changes from 1 to 0.  The passed parameter is the bit or bits that changed from 1 to 0 (gone negative).

Note that you cannot read the Status Value within the event handler.

See Also

Status Object

NegativeMask Property


PositiveEvent Event

Raised when the status associated with any non-zero bit in the PositiveMask changes.

Applies To:	Status Object

Syntax:	Dim WithEvents objStatus As Status
Set objStatus = Status
Sub objStatus_PositiveEvent(ByVal newStatus As VsaStatusBits)
  ...
End Sub

Parameter	Data Type	Default Value	Description
newStatus	VsaStatusBits	None	A constant that specifies the status bit or bits that were unmasked.
Remarks

This event is raised when a status bit associated with any non-zero bit in the PositiveMask changes from 0 to 1.  The passed parameter is the bit or bits that changed from 0 to 1 (gone positive).

Note that you cannot read the Status Value within the event handler.

See Also

Status Object

PositiveMask Property


Time Object

(Vector only)

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Gate †	RW	Get/set is time gating is enabled.
GateDelayChan †	RW	Get/set the time gate delay (in Sec) for the specified channel
GateLen †	RW	Get/set the time gate length (in Sec).
MainLen †	RW	Get/set the main time length (in Sec).
Overlap †	RW	Get/set the maximum amount of overlap processing when averaging is off.
OverlapAverage †	RW	Get/set the maximum amount of overlap processing when averaging is on.
Points †	RW	Get/set the number of main time points.
ResolutionAuto †	RW	Get/set time-resolution-auto flag.  When true, span is adjusted to achieve specified main time length.
Remarks

The Time object represents the time settings of a measurement, including time length, gating, and overlap processing.

The AgtVsaScalar application does not have a Time object.

See Also

Time Tab


Gate Property

(Vector only)

Get/set is time gating is enabled.

Applies To:	Time Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objTime.Gate
objTime.Gate = blnVal

Remarks

Determine whether time gating is enabled.  Time gating is not available for the digital demodulation measurement or for the VsaScalar application.

For more information, see the topic About Time Gating.

See Also

Time Tab (MeasSetup)


GateDelayChan Property

(Vector only)

Get/set the time gate delay (in Sec) for the specified channel

Applies To:	Time Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTime.GateDelayChan(iChan)
objTime.GateDelayChan(iChan) = dblVal

Parameter	Data Type	Default Value	Description
iChan	Integer	None	An integer, starting at 1, that specifies the input channel.
Remarks

Determine the gate delay, in seconds, for the specified input channel.  This is the delay from the beginning of the main time record to the start of the time gate.

For more information about time gating, refer to the topic About Time Gating.

See Also

Time Tab (MeasSetup)


GateLen Property

(Vector only)

Get/set the time gate length (in Sec).

Applies To:	Time Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTime.GateLen
objTime.GateLen = dblVal

Remarks

Determine the length of the time gate, in seconds.  For each channel, the sum of the GateDelayChan plus the GateLen must be less than or equal to the main time length (MainLen property).

For more information about time gating, refer to the topic About Time Gating.

See Also

Time Tab (MeasSetup)


MainLen Property

(Vector only)

Get/set the main time length (in Sec).

Applies To:	Time Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTime.MainLen
objTime.MainLen = dblVal

Remarks

Determine the length of the main time record, in seconds.  If ResolutionAuto is True, then the span is adjusted to achieve the specified main time length.  If ResolutionAuto is False, then the resolution bandwidth (RBW) is modified to achieve the main time length.

See Also

Main Time Length

ResolutionAuto Property


Overlap Property

(Vector only)

Get/set the maximum amount of overlap processing when averaging is off.

Applies To:	Time Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTime.Overlap
objTime.Overlap = dblVal

Remarks

Determine the percentage of overlap the analyzer uses for non-averaged measurements.

Overlap processing limits: 0% to 99.99%

Overlap processing lets you overlap time records.  In other words, some data from the first time record is re-used in the second time record, some data from the second time record is re-used in the third time record, and so forth.

For further details and an illustration, refer to the topic Overlap Processing

See Also

Max Overlap (Avg Off)


OverlapAverage Property

(Vector only)

Get/set the maximum amount of overlap processing when averaging is on.

Applies To:	Time Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTime.OverlapAverage
objTime.OverlapAverage = dblVal

Remarks

Determine the maximum amount of overlap processing, as a percentage, that the analyzer uses for averaged measurements.

The analyzer lets you specify separate overlaps for averaged and non-averaged measurements.  If averaging is on, the analyzer uses the Value of OverlapAverage to determine the maximum potential overlap.

Overlap processing can dramatically reduce the time needed to compute RMS averages with a given Variance.

Overlap processing limits: 0% to 99.99%

Overlap processing lets you overlap time records.  In other words, some data from the first time record is reused in the second time record, some data from the second time record is reused in the third time record, and so forth, as shown below.

For further details, refer to the topic Overlap Processing

See Also

Max Overlap (Avg On)


Points Property

(Vector only)

Get/set the number of main time points.

Applies To:	Time Object

Access:	Read/Write

Syntax:	Dim lngVal As Long
lngVal = objTime.Points
objTime.Points = lngVal

Remarks

For the VsaVector application, determines the number of main time points of data to acquire for each measurement scan.  This is an alternate way of specifying the Frequency.Points length and is equal to:

Time.Points = (Frequency.Points -1) * 1.28

See Also

Frequency Points


ResolutionAuto Property

(Vector only)

Get/set time-resolution-auto flag.  When true, span is adjusted to achieve specified main time length.

Applies To:	Time Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objTime.ResolutionAuto
objTime.ResolutionAuto = blnVal

Remarks

This property is ignored in digital demodulation.

See Also

Auto Time Resolution


Trace Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Active	RW	Get/set if this trace is the active trace.
Aperture	RW	Get/set the group delay aperture.
Data	R	Get the data (numbers) in the current trace format.
DataName	RW	Get/set which data is computed for this trace.
DataNameNoData	R	Get the 'No Data'  DataName.
DataNames	R	Get the list of all available DataNames.
DataNamesMath	R	Get the list of all defined math expression DataNames.
DataNamesMeas	R	Get the list of all available measurement DataNames.
DataNamesReg	R	Get the list of all saved data register DataNames.
DemodChipRate †	R	Get the demod chip rate for this trace.
DemodCodeOrder †	RW	Get/set which order is used for code bits for this trace.
DemodFreqUnit †	RW	Get/set the type of X-axis unit associated with demod frequency (OFDM) data.
DemodStateShape †	RW	Get/set the shape of the digital demod ideal state positions.
DemodStateSize †	RW	Get/set the size of the digital demod ideal state positions.
DemodSymbolShape †	RW	Get/set the shape of the marks at the digital demod symbol positions.
DemodTblFormat †	RW	Get/set the format of the digital demod symbol table.
DemodTimeUnit †	RW	Get/set the type of X-axis unit associated with demod time data.
Format	RW	Get/set the trace format.
Marker	-->	Returns the Marker object associated with the trace.
PhaseOffset	RW	Get/set the phase offset (degrees) for the unwrapped phase format.
RawData	R	Get the raw (e.g. complex) data.
RawData3GChanDemodInfo †	R	Get the selected 3G channel demod error/information for this trace.
RawData3GCompDemodInfo †	R	Get the selected 3G composite demod error/information for this trace.
RawDataComplex	R	Get whether the RawData is complex.
RawDataDemodInfo †	R	Get the selected demod error/information for this trace.
RawDataInfo	R	Get the selected information about this trace.
RawDataOFDMDemodInfo †	R	Get the selected OFDM demod error/information for this trace.
RawDataPoints	R	Get the number of points in the RawData.
RawDataStatus	R	Get the Status of the RawData.
RawDataValue	R	Retrieves the value of a data item in the error summary table.  The index to value mapping depends on the active trace.  See RawDataValueNames for data items available from the trace.
RawDataValueNames	R	List of the available data items from the trace.
RawDataValueUnit	R	Retrieves the units of a data item in the error summary table.  The index to value mapping depends on the active trace.  See RawDataValueNames for data items available from the trace.
RawDataXDelta	R	Get the delta X for the RawData.
RawDataXStart	R	Get the start X for the RawData.
Spectrogram	-->	Returns the Spectrogram object associated with the trace.
Title	R	Returns the trace title that is displayed in the top left corner of each trace.
TriggerRefLineVisible	RW	Get/set whether a trigger reference line is drawn on time traces for the current trigger channel (level and magnitude triggers only).
UnwrapRef	RW	Get/set the unwrapped phase reference (degrees).
VectorXCenter	RW	Get/set the X center scaling value for the vector trace formats.
Visible	RW	Get/set if this trace is visible.
XAxisUnit	R	Get the x-axis unit string.
XEyeLength †	RW	Get/set the digital demod x-axis eye length for eye diagram formats.
XLeft	RW	Get/set the left side of the x-axis scale.
XLog	RW	Get/set if the x-axis is shown in a linear or log scale.
XRight	RW	Get/set the right side of the x-axis scale.
XScaleAuto	RW	AutoScale the x-axis.
YAxisUnit	R	Get the y-axis unit string.
YLogRatio	RW	Get/set the ratio between the Top and Bottom when in vsaTrcFmtLogMagLin format.
YPerDiv	RW	Get/set the spacing between y-axis divisions.
YRefLevel	RW	Get/set the y-axis value of the reference line.
YRefPosition	RW	Get/set the position of the reference line.
YRefTrackRange	RW	Get/set if the reference level tracks changes in the input range.
YRefVisible	RW	Get/set if the y-axis reference line is visible.
YUnit	RW	Get/set the y unit type (Power, Peak, RMS).
ZAxisUnit	R	Get the z-axis unit string.
ZFirst	R	Get the z-axis value associated with the first data point.
ZLast	R	Get the z-axis value associated with the last data point.
ZPoints	R	Get the number of points in the z-axis.
Methods	Description
ApertureNearest	Get the nearest valid aperture.
CopyDataToClipboard	Copy the trace data (numbers)  to the clipboard.
CopyToDataReg	Copy this trace to the specified data register.
SaveFile	Save the trace in the specified format to a file.
ScaleAuto	X- and Y-AutoScale this trace.
WaitForValidTrace	Wait for up to the specified timeout (in msec) for the trace to contain valid data.
YScaleAuto	AutoScale the Y-axis.
Remarks

The Trace object represents a single trace, which can be one of four contained in the Traces collection.  A large number of properties can be set or read for each trace, including whether the trace is active, what data it contains, its format, Y and X scaling parameters, demodulation display settings, and access to the marker object.  The methods of the Trace object allow copying the trace to a data register, clipboard, or a file, and to perform auto-scaling of the trace.

The SaveFile method saves the trace data to a file in text format, MATLAB format, or SDF format (binary).

See Also

Trace Menu

Saving and Recalling Traces

Using Data Registers

Copy Trace Data

Activating Traces

Viewing Traces


Active Property

Get/set if this trace is the active trace.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objTrace.Active
objTrace.Active = blnVal

Remarks

There is always exactly one active trace. If you set Active to False for all traces, Trace A is the active trace.

See Also

Active Trace

ActiveIndex


Aperture Property

Get/set the group delay aperture.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim sngVal As Single
sngVal = objTrace.Aperture
objTrace.Aperture = sngVal

Remarks

The Aperture property sets or returns the Value of the group delay aperture, expressed as a percentage of the data.

See Also

Delay Aperture


Data Property

Get the data (numbers) in the current trace format.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objTrace.Data(vType, selData, bScaleLimit)

Parameter	Data Type	Default Value	Description
vType	Integer	None
selData	VsaTrcDataSelect	None
bScaleLimit	Boolean	None
Remarks

Data is a read-only property of the Trace object.  In this usage, reading the Data property returns the trace data in the format that is being displayed (e.g. log mag, phase, etc.).  The data returned is an array of numbers.

If bScaleLimit is True, then only the X scaled data that you see on the trace (between XLeft and XRight if XscaleAuto is False) is read.

The selData parameter is used to select which data to read: X data, Y data, or both X and Y data.  If both X and Y data are read, then the data is returned interleaved X followed by Y for each point.

There are three supported values of vType; vbSingle (the value of 4), vbDouble (5), and vbVariant (12).  If you are reading the data into a macro or other VBSript application, then you must use the vbVariant data type.  If you are reading data into the HP-VEE application, then vbDouble is the easiest format to use.  In most other cases, you would want to use the vbSingle data type, as it is the most compact.  You might want to use vbDouble instead of vbSingle if you are reading X data because, for large frequencies, you might need the extra resolution of a double value.


DataName Property

Get/set which data is computed for this trace.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim strVal As String
strVal = objTrace.DataName
objTrace.DataName = strVal

Remarks

The Trace object's DataName property sets or returns the string that identifies a data source for the specified trace.  This is the name that appears in the upper left corner of each trace to identify it.

Use the DataNames property to return an array containing all the current possible data sources.  If you are only interested in a subset of the available sources, use DataNamesMeas, DataNamesMath, DataNamesReg, or DataNameNoData to return only the Measurement, Math Functions, or Registers sources, or the name No Data, respectively.

See Also

Available Trace Data

DataNamesMeas Property


DataNameNoData Property

Get the 'No Data'  DataName.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objTrace.DataNameNoData

Remarks

The DataNameNoData property returns the string "No Data" so that you can supply it as a source (DataName property) for the specified trace.  Specifying the No Data source can speed up measurements because when a trace is told to display no data, no data is calculated for that trace.  You can specify an empty string to mean "No Data" for the DataName property

See Also

Available Trace Data

DataNamesMeas Property


DataNames Property

Get the list of all available DataNames.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objTrace.DataNames

Remarks

Use the DataNames property to return an array of strings containing all the current possible data sources.  You can use any of the names as a DataName.  If you are only interested in a subset of the available sources, use DataNamesMeas, DataNamesMath, DataNamesReg, or DataNameNoData to return only the Measurement, Math Functions, or Registers sources, or the name No Data, respectively.

See Also

Available Trace Data

DataNamesMeas Property


DataNamesMath Property

Get the list of all defined math expression DataNames.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objTrace.DataNamesMath

Remarks

Use the DataNamesMath property to return an array of strings containing all the possible math function data sources.  If no math functions have been defined (MathFuncs object), then an empty Variant is returned.  All math functions names returned with this function are prefixed with "Fn " so that the can be distinguished from measurement result names.  Any member of the list can be used as an argument to the DataName property.

See Also

Available Trace Data

DataNamesMeas Property


DataNamesMeas Property

Get the list of all available measurement DataNames.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objTrace.DataNamesMeas

Remarks

Returns an array of strings (see below) containing the built-in measurement results. Any member of the list can be used as an argument to the DataName property.  The DataNamesMeas list is a subset of the one returned by the DataNames property.  The possible Values returned by this property are dependant upon the current measurement and are affected by the number of channels in the measurement (Inputs.ChannelConfig), whether this is the VsaVector application or VsaScalar application, and demod configuration (Measurement.DemodConfig).

The following lists show all the strings returned for the built-in measurement functions.  The Variant is dynamically created at run time, so besides the strings listed below, there may be additional available strings naming mathematical functions and macros you have developed, and the names of traces or filters in data registers.

VsaScalar

VsaScalar single channel data names (add channel number after name)

PSD		Power Spectral Density
Spectrum		Spectrum
VsaVector, Demodulation Off

VsaVector single channel data names (add channel number after name)

Auto Correl		Auto Correlation
CCDF		Complementary Cumulation Density Function
CDF		Cumulative Density Function
Correction		Calibration correction
Gate Time		Gated time (only if Time Gating is on)
Inst Main Time		Instantaneous Main Time (before gating)
Inst Spec		Instantaneous Spectrum
Main Time		Main Time  (may be averaged)
PDF		Probability Density Function
PSD		Power Spectral Density
Spectrum		Spectrum (after Gating and may be averaged)
VsaVector cross channel data names

Coherence		Coherence
Cross Correl		Cross Correlation
Cross Spectrum		Cross Spectrum
Freq Response		Frequency Response
Impulse Response		Impulse Response
Analog Demodulation

In analog demodulation mode, all of the above except for "Correction" are also available after demodulation.  In this case the data names are prefixed with "AnDemod ".

Digital Demodulation

Digital demodulation is a single channel measurement, so the following results always show a channel 1 result:

VsaVector digital demodulation data names (non-FSK)

Ch Frequency Response1		Equalizer Channel Frequency Response (only if equalize is on)
Correction1		Calibration correction
Eq Impulse Response1		Equalizer Impulse Response (only is equalizer is on)
Error Vector Spec1		Error Vector Spectrum
Error Vector Time1		Error Vector Time
IQ Mag Error1		IQ Magnitude Error
IQ Meas Spec1		IQ Measured Spectrum
IQ Meas Time1		IQ Measured Time
IQ Phase Error1		IQ Phase Error
IQ Ref Spec1		IQ Reference Spectrum
IQ Ref Time1		IQ Reference Time
Inst Spectrum1		Instantaneous Spectrum (before demod)
Search Time1		Search Time
Spectrum1		Spectrum (before demod)
Syms/Errs1		Symbol / Error table
Time1		Time
VsaVector digital demodulation data names (FSK)

Carrier Mag Error1
Ch Frequency Response1		Equalizer Channel Frequency Response (only if equalize is on)
Correction1		Calibration correction
Eq Impulse Response1		Equalizer Impulse Response (only is equalizer is on)
FSK Error Spec1		FSK Error Spectrum
FSK Error Time1		FSK Error Time
FSK Meas Spec1		FSK Measured Spectrum
FSK Meas Time1		FSK Measured Time
FSK Ref Spec1		FSK Reference Spectrum
FSK Ref Time1		FSK Reference Time
Inst Spectrum1		Instantaneous Spectrum (before demod)
Search Time1		Search Time
Spectrum1		Spectrum (before demod)
Syms/Errs1		Symbol / Error table
Time1		Time
W-CDMA and cdma2000

VsaVector W-CDMA and cdma2000 Data Names

Pre-Demod  Data	Code-Domain  Data	CDMA  Channel-Specific Data	Composite-Time  Data
Correction1	CDP CDP Composite1	Chan Error Vector Time1	Comp Error Vector Spec1
Inst Spectrum1	CDP CDE Composite1	Chan IQ Mag Error1	Comp Error Vector Time1
Spectrum1	CDP CDP Layer1	Chan IQ Meas Time1	Comp IQ Mag Error1
Time1	CDP CDE Layer1	Chan IQ Phase Error1	Comp IQ Meas Spec1
	CDP Inst CDP Composite1	Chan IQ Ref Time1	Comp IQ Meas Time1
	CDP Inst CDE Composite1	Chan Syms/Errs1	Comp IQ Phase Error1
	CDP Inst CDP Layer1		Comp IQ Ref Spec1
	CDP Inst CDE Layer1		Comp IQ Ref Time1
			Comp Error Summary1
See Also

Available Trace Data

RawDataDemodInfo Property

RawData3GChanDemodInfo Property

RawData3GCompDemodInfo Property


DataNamesReg Property

Get the list of all saved data register DataNames.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objTrace.DataNamesReg

Remarks

Returns an array of strings naming trace data that is contained in any of the data registers. If there is not any trace data in the data registers, then an empty Variant is returned.  The data registers are designated by a data name in the range of "D1" through "D8".  Any member of the list can be used as an argument to the DataName property.

See Also

Available Trace Data

DataNamesMeas Property


DemodChipRate Property

(Vector only)

Get the demod chip rate for this trace.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objTrace.DemodChipRate

Remarks

This property returns the chip rate for the current trace, if the trace is the result of W-CDMA or cdma2000 demodulation.


DemodCodeOrder Property

(Vector only)

Get/set which order is used for code bits for this trace.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaTrcCodeOrder
enumVal = objTrace.DemodCodeOrder
objTrace.DemodCodeOrder = enumVal

Remarks

Data values in a 3G Code Domain Power measurement result that are not at the base symbol rate are contained in multiple points in the trace.  If the code order is bit reverse (vsaTrcCodeBitRev), then these points (at the same code channel / symbol rate) will be next to each other.  If the code order is Hadamard (vsaTrcCodeHadamard), then these points will be spread out through the trace.

See Also

Code Order


DemodFreqUnit Property

(Vector only)

Get/set the type of X-axis unit associated with demod frequency (OFDM) data.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaTrcFreqUnit
enumVal = objTrace.DemodFreqUnit
objTrace.DemodFreqUnit = enumVal

Remarks

This includes Error Vector Spectrum and Error Vector Time trace data types.

See Also

DemodTimeUnit

Trace->Digital Demod->Frequency Unit

ZPosition +Offset ZPosition


DemodStateShape Property

(Vector only)

Get/set the shape of the digital demod ideal state positions.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaTrcStateShape
enumVal = objTrace.DemodStateShape
objTrace.DemodStateShape = enumVal

Remarks

Determine the shape to be displayed on a trace for digital demodulation ideal state positions.  The shape may be turned off, be a cross, or a circle.

The ideal states positions are only shown on a Vector or constellation diagram. If you choose a cross, the ideal state occurs at the center of the cross. If you choose a circle, the ideal state occurs at the center of the circle.

The ideal state is the location where symbols occur if your signal is without error. Showing the ideal states gives a Visual indication of the quality of your signal.

You can also set the size of the ideal shapes with the DemodStateSize property.

For more information about digital demodulation refer to Setting up a Digital Demodulation Measurement

See Also

Ideal State


DemodStateSize Property

(Vector only)

Get/set the size of the digital demod ideal state positions.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim sngVal As Single
sngVal = objTrace.DemodStateSize
objTrace.DemodStateSize = sngVal

Remarks

Determine the ideal state size, as a percentage of Error Vector Magnitude (EVM), in Vector and constellation diagrams. Ideal states are shown as circles or crosses, as determined by the DemodStateShape property.

Range: 0.1% to 50%; the Value determines the radius of the ideal-state circle or ideal-state crosshair.

You can use this feature to determine if symbols have an EVM above a specified Value. For example, to see if any symbols have an EVM greater than 10%, set the state size to 10% and select Circle as the shape. Any symbols that fall outside of the circle (other than SYNC or PILOT symbols) have an EVM greater than 10%.

For more information about digital demodulation refer to Setting up a Digital Demodulation Measurement

See Also

Ideal State


DemodSymbolShape Property

(Vector only)

Get/set the shape of the marks at the digital demod symbol positions.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaTrcSymbolShape
enumVal = objTrace.DemodSymbolShape
objTrace.DemodSymbolShape = enumVal

Remarks

Determine the shape of actual symbols locations on digital demod time traces (for all trace formats other than Vector, constellation, and eye diagrams).  You can choose to not display the symbol positions, show a dot (actually a small box) on the symbol, or show a Vertical bar between the symbol and zero.

For more information refer to Setting up a Digital Demodulation Measurement

See Also

Symbol Shape


DemodTblFormat Property

(Vector only)

Get/set the format of the digital demod symbol table.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaTrcTblFormat
enumVal = objTrace.DemodTblFormat
objTrace.DemodTblFormat = enumVal

Remarks

Determine the numeric format to be used in the digital demod Symbol / Error table.  You can show the symbols in either binary or hexadecimal format.

For more information refer to Setting up a Digital Demodulation Measurement

See Also

Symbol Table Format


DemodTimeUnit Property

(Vector only)

Get/set the type of X-axis unit associated with demod time data.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaTrcTimeUnit
enumVal = objTrace.DemodTimeUnit
objTrace.DemodTimeUnit = enumVal

Remarks

Determine units for the time axis of displayed digital demod time traces.  You can display the time axis in either seconds or symbols.

See Also

Digital Demod Tab (Trace Properties)


Format Property

Get/set the trace format.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaTrcFormat
enumVal = objTrace.Format
objTrace.Format = enumVal

Remarks

Determines the trace format.  Not all trace formats are meaningful for all data types.  For example, the phase data types (Wrap phase, Unwrap phase, and Trellis-Eye) always show zero of real data (e.g. baseband time data).  The constellation format will show the same as I-Q if you are not displaying a digital demod measured or reference time trace.

See Also

Format tab


Marker Property

Returns the Marker object associated with the trace.

Applies To:	Trace Object

Syntax:	Dim objMarker As Marker
Set objMarker = objTrace.Marker

Remarks

Marker (a property of the Trace object) returns a Marker object.

For more information, see the topic Markers.

See Also

Marker Object


PhaseOffset Property

Get/set the phase offset (degrees) for the unwrapped phase format.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim sngVal As Single
sngVal = objTrace.PhaseOffset
objTrace.PhaseOffset = sngVal

Remarks

Determine the phase offset, in degrees, for unwrapping phase information.  This is only used if the trace Format is VsaTrcFmtUnwrapPhase.

See Also

Phase Offset


RawData Property

Get the raw (e.g. complex) data.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objTrace.RawData(vType)

Parameter	Data Type	Default Value	Description
vType	Integer	None	Array element data type
Remarks

RawData is a read-only property of the Trace object.  In this usage, reading the RawData property returns the raw (possibly complex) Y trace data before any trace format has been applied to the data.  The data returned is an array of numbers.

If the data of complex (RawDataComplex property), then the data is returned interleaved Y real part followed by Y imaginary part for each point.  The RawDataPoints property returns the number of complex/real points in the trace data.

If no data is available, then an empty Variant is returned.

If the trace contains spectrum data in the VsaVector application, then the non-alias protected data is also included in the returned data.  You can use the RawDataInfo("FreqValidMin") and RawDataInfo("FreqValidMax") to determine the minimum and maximum Valid frequencies for the data.

The RawDataXStart and RawDataXDelta properties can be used together to reconstruct the time/frequency axis for the data.

There are three supported Values of VType; VbSingle (the Value of 4), VbDouble (5), and VbVariant (12).  If you are reading the data into a macro or other VBSript application, then you must use the VbVariant data type.  If you are reading data into the HP-VEE application, then VbDouble is the easiest format to use.  In most other cases, you would want to use the VbSingle data type, as it is the most compact.

See Also

Data Property

DataName Property

RawDataComplex Property

RawDataXStart Property

RawDataXDelta Property

RawDataInfo Property


RawData3GChanDemodInfo Property

(Vector only)

Get the selected 3G channel demod error/information for this trace.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objTrace.RawData3GChanDemodInfo(eInfo)

Parameter	Data Type	Default Value	Description
eInfo	VsaTrc3GDemChanInfo	None	A constant that specifies the trace demodulation error information.
Remarks

Returns the specified W-CDMA or cdma2000 channel error and channel information for this trace.  This property is only valid when the following is True, otherwise an error is raised:

•	The trace contains a symbol/error table measurement result (DataName set to "Chan Syms/Errs1").

•	The data in the symbol/error table is W-CDMA or cdma2000 channel information (for composite errors, use RawData3GCompDemodInfo Property).

The VsaTrc3GDemChanInfo `eration contains constants for each entry in the symbol table.  You can use vsaTrcDem3GChanErrInfoMin and vsaTrcDem3GChanErrInfoCount to loop through all entries in the table by setting up a loop that counts from vsaTrcDem3GChanErrInfoMin to (vsaTrcDem3GChanErrInfoCount  − 1).

Returned Values

Any value less than -1e9 indicates that the error value does not apply to a particular standard (the information is not in the displayed symbol table).  For example, Pilot Bits does not apply for a cdma2000 measurement, so its value will be less than −1e9 (typically −1e10).

Any value greater than 1e9 indicates that the error value does not apply to the current measurement setup (the information is in the displayed symbol table, but the value is "N/A").  For example, T Trigger does not apply when triggering is turned off, so its value will be greater than 1e9 (typically 1e10).

The one other special case in the error array is the Slot value. For W-CDMA, the label for this value is "Slot".  For cdma2000, the label is "PCG".  To indicate this to the display code, cdma2000 measurements add the value 1e5 to the actual slot number.  The display code looks for a value greater than or equal to 1e5 to determine if the label should be "PCG", otherwise the label is "Slot".

See Also

DataName Property

RawData3GCompDemodInfo Property

About Channel Errors (cdma2000)

About Channel Errors (W-CDMA)


RawData3GCompDemodInfo Property

(Vector only)

Get the selected 3G composite demod error/information for this trace.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objTrace.RawData3GCompDemodInfo(eInfo)

Parameter	Data Type	Default Value	Description
eInfo	VsaTrc3GDemCompInfo	None	A constant that specifies the trace demodulation error information.
Remarks

Returns the specified W-CDMA or cdma2000 composite error/information for the selected trace.  This property is only valid when the following is True, otherwise an error is raised:

•	The trace contains a symbol/error table measurement result (DataName set to "Comp Error Summary1").

•	The data in the symbol/error table is W-CDMA or cdma2000 composite information (for channel errors, use RawData3GChanDemodInfo Property).

The VsaTrc3GDemCompInfo enumeration contains constants for each entry in the symbol table.  You can use vsaTrcDem3GCompErrInfoMin and vsaTrcDem3GCompErrInfoCount to loop through all entries in the table by setting up a loop that counts from vsaTrcDem3GCompErrInfoMin to (vsaTrcDem3GCompErrInfoCount  − 1).

Returned Values

Any value less than -1e9 indicates that the error value does not apply to a particular standard (the information is not in the displayed symbol table).  For example, Pilot Bits does not apply for a cdma2000 measurement, so its value will be less than −1e9 (typically −1e10).

Any value greater than 1e9 indicates that the error value does not apply to the current measurement setup (the information is in the displayed symbol table, but the value is "N/A").  For example, T Trigger does not apply when triggering is turned off, so its value will be greater than 1e9 (typically 1e10).

The one other special case in the error array is the Slot value. For W-CDMA, the label for this value is "Slot".  For cdma2000, the label is "PCG".  To indicate this to the display code, cdma2000 measurements add the value 1e5 to the actual slot number.  The display code looks for a value greater than or equal to 1e5 to determine if the label should be "PCG", otherwise the label is "Slot".

See Also

DataName Property

RawData3GChanDemodInfo Property

About the Composite Error Summary Table  (cdma2000)

About the Composite Error Summary Table  (W-CDMA)


RawDataComplex Property

Get whether the RawData is complex.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim blnVal As Boolean
blnVal = objTrace.RawDataComplex

Remarks

Returns whether the raw trace returned by the RawData property contains complex data (interleaved real followed by imaginary for each point).

See Also

RawData Property


RawDataDemodInfo Property

(Vector only)

Get the selected demod error/information for this trace.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objTrace.RawDataDemodInfo(eInfo)

Parameter	Data Type	Default Value	Description
eInfo	VsaTrcDemInfo	None	A constant that specifies the trace demodulation error information.
Remarks

Returns the specified digital demodulation error/information for this trace.  This is only Valid for a symbol / error table measurement result (DataName set to "Syms/Errs1"), otherwise an error is raised.

See Also

DataName Property

About the Symbol Table (digital demodulation)


RawDataInfo Property

Get the selected information about this trace.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objTrace.RawDataInfo(sInfoName)

Parameter	Data Type	Default Value	Description
sInfoName	String	None	A string that specifies the data information to get.
Remarks

Returns selected information about this trace.  The returned Value is a Variant and may be a boolean, integer, long, real, double, string, or an array of numbers.  These name/value pairs form the data header that is saved with a trace in a file.  The fields are described in Sharing Data.  For example, use RawDataInfo("TrcLedStr") to get the trace indicator string (e.g. "CAL?") and use RawDataInfo("TrcLedReason") to get the reason behind the indicator (e.g. "Calibration data is unavailable.").


RawDataOFDMDemodInfo Property

(Vector only)

Get the selected OFDM demod error/information for this trace.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objTrace.RawDataOFDMDemodInfo(eInfo)

Parameter	Data Type	Default Value	Description
eInfo	VsaTrcOFDMDemInfo	None	A constant that specifies the trace demodulation error information
Remarks

Returns the specified HIPERLAN/2 or 802.11a error information for the selected trace.

The VsaTrcOFDMDeminfo `eration contains constants for each entry in the symbol table.  You can use vsaTrcDemOFDMErrInfoMin and vsaTrcOFDMErrInfoCount to loop through all entries in the table by setting up a loop that counts from vsaTrcOFDMErrInfoMin to (vsaTrcOFDMErrInfoCount  − 1).

Returned Values

Any value greater than 1e9 indicates that the error value does not apply to the current measurement setup (the information is in the displayed symbol table, but the value is "N/A").  For example, the vsaTrcDemOFDMErrInfoBitsPerSym (bits per symbol for subcarrier) value does not apply to HIPERLAN/2 signals, and a value of 1e10 would be specified.


RawDataPoints Property

Get the number of points in the RawData.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim lngVal As Long
lngVal = objTrace.RawDataPoints

Remarks

Returns the number of points (real or complex) that is returned by the RawData property.

The RawDataComplex property returns whether the trace data is complex.

If the trace contains spectrum data in the VsaVector application, then the non-alias protected data is also included in the returned data.  You can use the RawDataInfo("FreqValidMin") and RawDataInfo("FreqValidMax") to determine the minimum and maximum Valid frequencies for the data.

See Also

RawData Property

RawDataComplex Property

RawDataInfo Property


RawDataStatus Property

Get the Status of the RawData.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim enumVal As VsaTrcDataStatus
enumVal = objTrace.RawDataStatus

Remarks

Returns the status of the trace data, which may indicate measurement inaccuracies or error conditions.  The returned Value is a sum of the VsaTrcDataStatus bits as follows:

VsaTrcDataStatus Bits	Description
vsaTrcDatStaNull	This bit is equal to zero and represents no status bits set.
vsaTrcDatStaNoData	This bit is set if the trace does not contain Valid data.
vsaTrcDatStaQuestionable	This bit is set if the data may not accurately reflect the current measurement.
vsaTrcDatStaOverload	This bit is set if measurement data may contain overloaded input data.
vsaTrcDatStaUnCalibrated	This bit is set if measurement data is uncalibrated.
vsaTrcDatStaNoPulse	This bit is set if the digital demodulation measurement is set to pulse search and no pulse is found.
vsaTrcDatStaNoSync	This bit is set if the digital demodulation measurement is set to sync search and no sync is found.
vsaTrcDatStaCarrierUnlocked	This bit is set if the digital demodulation measurement is unable to lock to the carrier.
vsaTrcDatStaEqualized	This bit is set if the digital demodulation equalizer is enabled and the data has been equalized.
vsaTrcDatStaRng	This bit is set on PDF or CDF traces if they find an input sample with a magnitude larger than the current input range setting.  It serves mostly as a warning that there is data outside of the histogram that the analyzer displays.  This can also potentially be useful when setting the input range, as a way of deciding whether the range is close to overload.
vsaTrcDatStaAllPts	This bit is set on frequency traces if you turn on the "Show All Points" feature.  This feature is in the analyzer's main menu under Display/Appearance/Trace/Show All Frequency Points.  When "Show All Points" is set, the display will show all points in the frequency spectrum, including those that are not alias protected, those which are negative frequencies, and those which are outside of the specified frequency range.
vsaTrcDatStaMeasOffset	Some traces in W-CDMA and cdma2000 ignore the current setting of Measurement Interval and Measurement Offset, and always operate on the first slot (PCG) in the measurement.  For these traces, vsaTrcDatStaMeasOffset is set if the Measurement Interval is greater than one, or if the Measurement Offset is non-zero.  This serves as a reminder that the results in the trace don't follow the interval and offset.
vsaTrcDatStaChInactive	This bit is set on W-CDMA or cdma2000 traces if the data they contain is for a specific channel (such as Channel IQ Meas Time) and the currently selected channel is not active.


RawDataValue Property

Retrieves the value of a data item in the error summary table.  The index to value mapping depends on the active trace.  See RawDataValueNames for data items available from the trace.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objTrace.RawDataValue(iIdx)

Parameter	Data Type	Default Value	Description
iIdx	Integer	None	Identifies the  Error Summary parameter that the measurement results apply to.
Remarks

The complete Error Summary data result is described by the RawDataValuesNames, RawDataValue(iIdx) and RawDataValueUnit(iIdx) properties, which provide the name of the measured parameter, its measured value and its measurement units respectively.

The index "iIdx" number identifies specific Error Summary data names and are uniquely defined for a given Error Summary table and Demodulation format.  The RawDataValuesNames property can be used to obtain the available list of Error Summary data names. This list is used to assign the corresponding index numbers used by RawDataValue(iIdx) and RawDataValueUnit(iIdx) properties.  The "TableVals" macro has been provided to accomplish this task for you.  For complete details and instructions to use this macro, see the "TableVals (Sample Macros)" topic.

TIP

It is highly recommended that you use the "TableVals"" macro to get a listing of the available Error Summary data names and their corresponding index "ildx" numbers. (Highlight the desired Error Summary Table as the Active Trace, click Utilities > Macros.., select "TableVals", click Run).

See Also

RawDataValuesNames Property

RawDataValueUnit Property

TableVals Macor


RawDataValueNames Property

List of the available data items from the trace.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim varVal As Variant
varVal = objTrace.RawDataValueNames

Remarks

RawDataValueNames returns an array containing a list of the available Error Summary data names for the Active Error Summary Table trace display. You can use this list of data names to determine the corresponding index numbers used by the RawDataValue(iIdx) and RawDataValueUnit(iIdx)  properties.  An index value is assigned for each data name, the assignments start at 0 for the first data name and continue consecutively for the remaining names.

Example: TD-SCDMA Chan Error Summary Table

RawDataValueNames List	Assigned Index numbers
EVM	0
EVMPeak	1
EVMPeakLoc	2
MagErr	3
MagErrPeak	4
MagErrPeakLoc	5
PhaseErr	6
PhaseErrPeak	7
PhaseErrPeakLoc	8
CodePhase	9
TIP

It is highly recommended that you use the "TableVals"" macro to get a listing of the available Error Summary data names and their corresponding index "ildx" numbers. (Highlight the desired Error Summary Table as the Active Trace, click Utilities > Macros.., select "TableVals", click Run).

The complete Error Summary data result is described by the RawDataValuesNames, RawDataValue(iIdx) and RawDataValueUnit(iIdx) properties, which provide the name of the measured parameter, its measured value and its measurement units respectively.

The index "iIdx" number identifies specific Error Summary data names and are uniquely defined for a given Error Summary table and Demodulation format.  The "TableVals " macro has been provided to automate the steps required to find the list of available error data names and their corresponding indexes "iIdx", see "TableVals " example macro topic.

See Also

RawDataValue Property

RawDataValueUnit Property

Sample Macro - TableVals


RawDataValueUnit Property

Retrieves the units of a data item in the error summary table.  The index to value mapping depends on the active trace.  See RawDataValueNames for data items available from the trace.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objTrace.RawDataValueUnit(iIdx)

Parameter	Data Type	Default Value	Description
iIdx	Integer	None	Identifies the  Error Summary parameter that the measurement results apply to.
Remarks

The complete Error Summary data result is described by the RawDataValuesNames, RawDataValue(iIdx) and RawDataValueUnit(iIdx) properties, which provide the name of the measured parameter, its measured value and its measurement units respectively.

The index "iIdx" number identifies specific Error Summary data names and are uniquely defined for a given Error Summary table and Demodulation format.  The RawDataValuesNames property can be used to obtain the available list of Error Summary data names. This list is used to assign the corresponding index numbers used by RawDataValue(iIdx) and RawDataValueUnit(iIdx) properties.  The "TableVals" macro has been provided to accomplish this task for you.  For complete details and instructions to use this macro, see the "TableVals (Sample Macros)" topic.

TIP

It is highly recommended that you use the "TableVals"" macro to get a listing of the available Error Summary data names and their corresponding index "ildx" numbers. (Highlight the desired Error Summary Table as the Active Trace, click Utilities > Macros.., select "TableVals", click Run).

See Also

RawDataValuesNames Property

RawDataValue Property

TableVals macro


RawDataXDelta Property

Get the delta X for the RawData.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objTrace.RawDataXDelta

Remarks

Returns the X delta for the raw trace data.  The RawDataXStart and RawDataXDelta properties can be used together to reconstruct the time/frequency axis for the data.

If the trace contains spectrum data in the VsaVector application, then the non-alias protected data is also included in the data.  You can use the RawDataInfo("FreqValidMin") and RawDataInfo("FreqValidMax") to determine the minimum and maximum Valid frequencies for the data.

See Also

RawDataXStart Property

RawDataInfo Property

RawData Property


RawDataXStart Property

Get the start X for the RawData.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objTrace.RawDataXStart

Remarks

Returns the X start for the raw trace data.  The RawDataXStart and RawDataXDelta properties can be used together to reconstruct the time/frequency axis for the data.

If the trace contains spectrum data in the VsaVector application, then the non-alias protected data is also included in the data.  You can use the RawDataInfo("FreqValidMin") and RawDataInfo("FreqValidMax") to determine the minimum and maximum Valid frequencies for the data.

See Also

RawDataXDelta Property

RawDataInfo Property

RawData Property


Spectrogram Property

Returns the Spectrogram object associated with the trace.

Applies To:	Trace Object

Syntax:	Dim objSpectrogram As Spectrogram
Set objSpectrogram = objTrace.Spectrogram

Remarks

This property (of the Trace object) returns a spectrogram object.


Title Property

Returns the trace title that is displayed in the top left corner of each trace.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objTrace.Title

Remarks

Sets or returns a string which is the user's Title for the running application.  The title is the text that is on the bar at the top of main application window.  If the title is an empty string, then the application will display its default title.


TriggerRefLineVisible Property

Get/set whether a trigger reference line is drawn on time traces for the current trigger channel (level and magnitude triggers only).

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objTrace.TriggerRefLineVisible
objTrace.TriggerRefLineVisible = blnVal

Remarks

This property returns True if the trigger reference line is on, False if it is off.  You can also set the value of this property to turn the trigger reference line on or off.


UnwrapRef Property

Get/set the unwrapped phase reference (degrees).

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTrace.UnwrapRef
objTrace.UnwrapRef = dblVal

Remarks

Determine the unwrapped phase reference, in degrees, for the trace.

Wrapped phase means that all phase is shifted to between -180 degrees and +180 degrees. If the actual phase is outside this range, it is increased or decreased by a multiple of 360 degrees to put it between -180 and +180 degrees.

For example, +400 degrees is returned as +40 degrees (400 - 360 = 40), and -190 degrees as +170 degrees (-190 + 360 = 170).

Unwrapped phase lets you designate the point (x-axis) Value about which phase Values are to be unwrapped. This would typically be a well known point in a measurement such as the passband of a band pass filter.

The UnwrapRef is only used if the trace format is set to unwrapped phase.

See Also

Unwrap Reference


VectorXCenter Property

Get/set the X center scaling value for the vector trace formats.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTrace.VectorXCenter
objTrace.VectorXCenter = dblVal

Remarks

The Vector trace formats are I-Q and constellation.  When you are in one of these formats you set the Y scaling with the YRefLevel, YRefPosition, and YPerDiv properties.  The width of the X axis is determined by the Y axis scaling and the aspect ratio of the trace.  The VectorXCenter property is used to set the center of the X axis when you are displaying data in this Vector format.

See Also

Vector X Center


Visible Property

Get/set if this trace is visible.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objTrace.Visible
objTrace.Visible = blnVal

Remarks

It is useful to hide the analyzer window if you are programming and do not need to see any displayed data or do not want a user to access the analyzer's user interface.

When you create the application object programmatically, Visible is defaulted to False.  If you start the application from a user interface, Visible is defaulted to True.

For the spectrogram object, this property sets or gets whether the spectrogram is turned on (TRUE = on, FALSE = off).  The data in the spectrogram is cleared when the spectrogram is turned off.


XAxisUnit Property

Get the x-axis unit string.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objTrace.XAxisUnit

Remarks

Returns the units on the X axis of the trace. If the trace format is I-Q or constellation, then the XAxisUnit is the same as the YAxisUnit.


XEyeLength Property

(Vector only)

Get/set the digital demod x-axis eye length for eye diagram formats.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim sngVal As Single
sngVal = objTrace.XEyeLength
objTrace.XEyeLength = sngVal

Remarks

The eye length has a range of 0.1 to 0.9 in steps of 0.1 and 1 to 40 in steps of 1.

For details, refer to the topic Eye Diagrams.

See Also

Eye Length


XLeft Property

Get/set the left side of the x-axis scale.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTrace.XLeft
objTrace.XLeft = dblVal

Remarks

Determine the left side of the X axis.  Setting this property also sets the XScaleAuto property to False.  If XScaleAuto is True, then XLeft returns the smallest X Value of the data.  The XRight property sets the right side of the X axis.

If the trace format is I-Q or constellation, then setting XLeft and XRight select how much data to display, but does not affect the X axis annotation.

See Also

Left Reference


XLog Property

Get/set if the x-axis is shown in a linear or log scale.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objTrace.XLog
objTrace.XLog = blnVal

Remarks

This property is not used if the trace format is I-Q or constellation.

See Also

Log X-Axis


XRight Property

Get/set the right side of the x-axis scale.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTrace.XRight
objTrace.XRight = dblVal

Remarks

Determine the right side of the X axis.  Setting this property also sets the XScaleAuto property to False.  If XScaleAuto is True, then XRight returns the largest X Value of the data.  The XLeft property sets the left side of the X axis.

If the trace format is I-Q or constellation, then setting XLeft and XRight select how much data to display, but does not affect the X axis annotation.

See Also

Right Reference


XScaleAuto Property

AutoScale the x-axis.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objTrace.XScaleAuto
objTrace.XScaleAuto = blnVal

Remarks

Determine whether the X axis automatically scales to the incoming data.  If XScaleAuto is True, then XLeft and XRight return the range of X Values of the data.  Setting either XLeft or XRight sets XscaleAuto to False.

See Also

Full Scale


YAxisUnit Property

Get the y-axis unit string.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objTrace.YAxisUnit

Remarks

Returns the units on the Y axis of the trace. The Y axis units are determined by type of data on the trace, the Format of the trace, and the Y units.

See Also

Format Property

Yunit Property


YLogRatio Property

Get/set the ratio between the Top and Bottom when in vsaTrcFmtLogMagLin format.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTrace.YLogRatio
objTrace.YLogRatio = dblVal

Remarks

This property is only used if Format is set to VsaTrcFmtLogMagLin.  In this format type, you set the YLogRatio instead of YPerDiv to determine Y scaling.

See Also

Y Ratio


YPerDiv Property

Get/set the spacing between y-axis divisions.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTrace.YPerDiv
objTrace.YPerDiv = dblVal

Remarks

The Y axis always contains 10 divisions.  Therefore, the trace height is 10 * YPerDiv

If the Format is set to VsaTrcFmtLogMagLin, then YPerDiv is ignored and YLogRatio is used to determine the trace height.

See Also

Y Per Division


YRefLevel Property

Get/set the y-axis value of the reference line.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTrace.YRefLevel
objTrace.YRefLevel = dblVal

Remarks

Together, the YRefLevel, YRefPosition, and YPerDiv can be used to determine the trace height.  The YscaleAuto method sets the YRefLevel and YPerDiv to Values which maintain round numbers for the top of the trace and a YPerDiv, and maximizes the height of the data on the trace.

The YRefVisible property determines whether a line is drawn on the trace showing the reference level.

The YAxisUnit property returns the units of the Y axis.

See Also

Reference Level


YRefPosition Property

Get/set the position of the reference line.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTrace.YRefPosition
objTrace.YRefPosition = dblVal

Remarks

Determine the position of the reference line on the Y axis, where 100 is the top of the trace, 50 is the center of the trace, and 0 is the bottom of the trace.

See Also

Reference Line


YRefTrackRange Property

Get/set if the reference level tracks changes in the input range.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objTrace.YRefTrackRange
objTrace.YRefTrackRange = blnVal

Remarks

This property is not used if the trace format is any phase format or group delay, the data is recalled, the data does not represent a Voltage amplitude, or the ChannelConfig is in I+jQ mode.

See Also

Range Tracking


YRefVisible Property

Get/set if the y-axis reference line is visible.

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objTrace.YRefVisible
objTrace.YRefVisible = blnVal

Remarks

The YRefPosition property determines the position of the reference line on the display.

See Also

Reference Line


YUnit Property

Get/set the y unit type (Power, Peak, RMS).

Applies To:	Trace Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaTrcYUnit
enumVal = objTrace.YUnit
objTrace.YUnit = enumVal

Remarks

Determine what units to display the amplitude of the data.  You can select Peak, RMS, Power units, or an automatic selection.  The automatic selection is to show Power units for frequency domain data and Peak units for time domain data.

See Also

Y Unit


ZAxisUnit Property

Get the z-axis unit string.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim strVal As String
strVal = objTrace.ZAxisUnit

Remarks

The z-axis units are associated with the ZFirst and ZLast properties.

See Also

ZFirst

ZLast

ZPosition + Offset ZPosition


ZFirst Property

Get the z-axis value associated with the first data point.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objTrace.ZFirst

Remarks

The first ZPoints of the data all have the same z-axis value. The increment to the next z-axis value (associated with the next ZPoints of data) can be computed as follows:

Incr=(ZLast – ZFirst)/(ZPoints – 1)

See Also

ZLast

ZPoints

ZPosition + Offset ZPosition


ZLast Property

Get the z-axis value associated with the last data point.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim dblVal As Double
dblVal = objTrace.ZLast

Remarks

The first ZPoints of the data all have the same z-axis value. The increment to the next z-axis value (associated with the next ZPoints of data) can be computed as follows:

Incr=(ZLast – ZFirst)/(ZPoints – 1)

See Also

ZFirst

ZPoints

ZPosition + OffsetZPosition


ZPoints Property

Get the number of points in the z-axis.

Applies To:	Trace Object

Access:	Read only

Syntax:	Dim lngVal As Long
lngVal = objTrace.ZPoints

Remarks

The first ZPoints of the data all have the same z-axis value. The increment to the next z-axis value (associated with the next ZPoints of data) can be computed as follows:

Incr=(ZLast – ZFirst)/(ZPoints – 1)

See Also

ZFirst

ZLast

ZPosition + Offset ZPosition


ApertureNearest Method

Get the nearest valid aperture.

Applies To:	Trace Object

Syntax:	Dim sngVal As Single
sngVal = objTrace.ApertureNearest(pct)

Parameter	Data Type	Default Value	Description
pct	Single	None	Single-precision number in the range 0.125 to 16 specifying a group delay aperture as a percentage.
Remarks

Frequency domain data: The aperture is set as a percentage of the current frequency span.
Time-Domain data: Aperture is set as a percentage of the time record length.

The Trace object's ApertureNearest method returns the nearest Valid aperture to the one specified in the pct parameter.  If you attempt to set an inappropriate aperture Value, the software automatically calls the ApertureNearest method, or your program can call it explicitly.

Valid aperture Values:

0.125%	2%

0.25%	4%

0.5%	8%

1%	16%

For more information, refer to the topic Group Delay Aperture.


CopyDataToClipboard Method

Copy the trace data (numbers)  to the clipboard.

Applies To:	Trace Object

Syntax:	objTrace.CopyDataToClipboard

Remarks

Copy the data to the clipboard as it appears on the displayed trace in the specified format with the specified X scaling.  The numbers are 2 per line, X followed by Y (separated by a tab) for each point.

See Also

Copy Trace Data


CopyToDataReg Method

Copy this trace to the specified data register.

Applies To:	Trace Object

Syntax:	objTrace.CopyToDataReg(iReg)

Parameter	Data Type	Default Value	Description
iReg	Integer	None	An integer in the range 1 - 8 specifying one of 8 available data registers.
Remarks

This method overwrites any previous results in the specified data register.  The DataReg.Remove method removes the data register from memory.  The DataReg.RecallFile method copies a file into the specified data register.

See Also

Copy Trace


SaveFile Method

Save the trace in the specified format to a file.

Applies To:	Trace Object

Syntax:	objTrace.SaveFile(sFileName, [sFmt], [bHdr])

Parameter	Data Type	Default Value	Description
sFileName	String	None	The name of the file to save to.
sFmt	String		The file format.
bHdr	Boolean	True	Flag that determines whether the data header is saved with the data.  True includes the data header, False does not.
Remarks

Saves the trace data to the specified file. The format may be one of the following:

•	CSV - Comma Separated Variables

•	MAT - MATLAB format

•	MAT4 - MATLAB Version 4 format

•	SDF, DAT, TIM - 89400 file format

•	TXT - Tab separated variables

If the format is an empty string, then the analyzer automatically determines the file format by looking at the file suffix.  If this is not sufficient, then a default format is chosen.

If the bHdr parameter is False, then the data header is not saved with the data.  This means if you recall the trace back into the instrument, the annotation and units for the data will not be restored.

Note that this method always saves trace and recording header information (which is optional when running the application manually). This means that if you wish to load the saved trace or recording into some other application, such as a database or some other signal analysis application, you will need to strip out the header information using a text editor.

See Also

Recall Trace


ScaleAuto Method

X- and Y-AutoScale this trace.

Applies To:	Trace Object

Syntax:	objTrace.ScaleAuto

Remarks

This method sets XScaleAuto to True and calls the YsSaleAuto method.


WaitForValidTrace Method

Wait for up to the specified timeout (in msec) for the trace to contain valid data.

Applies To:	Trace Object

Syntax:	objTrace.WaitForValidTrace([timeOut])

Parameter	Data Type	Default Value	Description
timeOut	Long	10000	This parameter is optional.  It is the amount of time to wait (in msec) for the trace to contain valid data.
Remarks

This method lets you pause your code (synchronously wait) until valid data appears in the corresponding trace.


YScaleAuto Method

AutoScale the Y-axis.

Applies To:	Trace Object

Syntax:	objTrace.YScaleAuto

Remarks

YScaleAuto sets the YPerDiv and YRefLevel to values that maximize the display size of the Y axis for the currently displayed data while retaining Y trace annotation numbers that are easy to work with.

See Also

Trace->Yscale-> AutoScale


Traces Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
ActiveIndex	RW	Get/set the index of the active trace.
ActiveTrace	-->	Get the active trace object.
AnnotationVisible	RW	Get/set if the text around the traces is visible.
Count	R	Get the number of traces (always 4).
GridVisible	RW	Get/set if the grid (graticule) of the traces are visible.
Item	-->	Get the specified trace object.
Layout	RW	Get/set the layout of the traces on the display.
ShowAllPoints	RW	Get/set if non-alias protected spectrum points are shown
XCenterFreq	RW	Get/set whether all traces show X frequency annotation as center/span rather than start/stop.
Methods	Description
CopyMarkersToClipboard	Copy the displayed markers to the clipboard.
ScaleAuto	X- and Y-AutoScale all traces
Remarks

The Traces object contains a collection of four Trace objects.  In addition, you can set global trace properties from this object, such as which parts of the trace are Visible and the extent of the data that is shown.

The Layout property selects or returns where traces are shown on the screen, which can display a single trace, two of them stacked, or 4 traces, either stacked or in quadrants

See Also

Display Appearance Dialog Box

Display Layout

Activating Traces


ActiveIndex Property

Get/set the index of the active trace.

Applies To:	Traces Object

Access:	Read/Write

Syntax:	Dim intVal As Integer
intVal = objTraces.ActiveIndex
objTraces.ActiveIndex = intVal

Remarks

The returned Value is an integer in the range of 1-4, corresponding to traces A-D, respectively.  This property is a shortcut, so that you don't have to check the Active property of every trace.

See Also

Activating Traces

Active Property

ActiveTrace Property


ActiveTrace Property

Get the active trace object.

Applies To:	Traces Object

Syntax:	Dim objActiveTrace As Trace
Set objActiveTrace = objTraces.ActiveTrace

Remarks

This property is similar to the ActiveIndex property, except it returns a reference to a Trace object.  This property is useful to use in macros where you might want to do some operation on a user-select trace.  This is a read-only property.  Use the Traces.ActiveIndex or the Trace.Active property to set the active trace.

See Also

Activating Traces

ActiveIndex Property

ActiveTrace Property


AnnotationVisible Property

Get/set if the text around the traces is visible.

Applies To:	Traces Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objTraces.AnnotationVisible
objTraces.AnnotationVisible = blnVal

Remarks

The AnnotationVisible property applies to the entire Traces collection, and sets or returns the Visibility of all text surrounding the trace grid.

See Also

Trace Tab (Display Appearance)


Count Property

Get the number of traces (always 4).

Applies To:	Traces Object

Access:	Read only

Syntax:	Dim intVal As Integer
intVal = objTraces.Count

Remarks

The Count property is Read-only, and returns the number of individual items in the collection.


GridVisible Property

Get/set if the grid (graticule) of the traces are visible.

Applies To:	Traces Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objTraces.GridVisible
objTraces.GridVisible = blnVal

Remarks

Determine whether the grid lines on all traces are Visible.

See Also

Trace Tab (Display Appearance)


Item Property

Get the specified trace object.

Applies To:	Traces Object

Syntax:	Dim objTrace As Trace
Set objTrace = objTraces.Item(Index)

Parameter	Data Type	Default Value	Description
Index	Integer	None	Gets specified item.
Remarks

Two properties help to manage every collection.  The default property, Item, returns a reference to an object in the collection.

The other property of every collection is the read-only Count property, which returns the number of objects in the collection.  The Count property can then be used to iterate through the collection.

The Item property has an index parameter, which may be a numeric index (1 is first Value) of the object in the collection.  For the ArbSources, Macros, or MathFuncs object, the index may also be a string key, which is the name of the object (see Name property)

See Also

Count Property


Layout Property

Get/set the layout of the traces on the display.

Applies To:	Traces Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaTrcLayout
enumVal = objTraces.Layout
objTraces.Layout = enumVal

Remarks

Determine the arrangement of traces on the display.  You may display a single trace, two or four traces stacked, or four traces with one trace in each quadrant.  You may also overlay (with the Trace.Visible property) multiple traces in the same area for single or two stacked trace layouts.

See Also

Display Layout

Viewing Traces


ShowAllPoints Property

Get/set if non-alias protected spectrum points are shown

Applies To:	Traces Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objTraces.ShowAllPoints
objTraces.ShowAllPoints = blnVal

Remarks

Determine whether all frequency points of all traces are shown.  Normally, in VsaVector, only the alias protected points in frequency domain data are shown.  Setting the property to True causes even the non-alias protect points to be shown.

See Also

Show All Frequency Points


XCenterFreq Property

Get/set whether all traces show X frequency annotation as center/span rather than start/stop.

Applies To:	Traces Object

Access:	Read/Write

Syntax:	Dim blnVal As Boolean
blnVal = objTraces.XCenterFreq
objTraces.XCenterFreq = blnVal

Remarks

Returns whether all the traces have an X axis that displays the center and span frequencies, or the start and stop frequencies.  This setting has no effect on a trace if it does not contain frequency domain data, is shown in I-Q or constellation format, or the X axis is scaled (XscaleAuto is set to False).

See Also

Show Center/Span

Show Frequency Center/Span on all traces


CopyMarkersToClipboard Method

Copy the displayed markers to the clipboard.

Applies To:	Traces Object

Syntax:	objTraces.CopyMarkersToClipboard

Remarks

Copy the text of the marker annotation window to the clipboard.  The marker annotation window is below the traces and above the measurement status area.  If no markers are on, then an error is raised.

See Also

Copy Markers


ScaleAuto Method

X- and Y-AutoScale all traces

Applies To:	Traces Object

Syntax:	objTraces.ScaleAuto

Remarks

This method sets XScaleAuto to True and calls the YsSaleAuto method.


Trigger Object

† = Only available with the Vector Signal Analyzer application
‡ = Only available with the Spectrum Signal Analyzer application

Properties	Description
Channel	RW	Get/set the input channel that is triggered.
Delay	RW	Get/set the trigger delay.
ExtLevel	RW	Get/set the external trigger level.
Holdoff	RW	Get/set the trigger hold-off (in Sec).
Level	RW	Get/set the trigger level for the specified input channel.
MagLevel	RW	Get/set the magnitude trigger level for the specified input channel.
Slope	RW	Get/set the trigger slope.
Style	RW	Get/set the trigger style.
Remarks

The Trigger object represents the measurement triggering functionality.  Only one input channel can control triggering the measurement.  You can set the trigger level, hold off, delay, slope and the style of trigger.  If the trigger style is free run, then all the other property Values are ignored.  There are two trigger objects, one for the hardware (Measurement.Inputs) and one for the recording playback (Measurement.Recording) in the AgtVsaVector application.

See Also

Trigger Tab

About Trigger

Playback Trigger Tab


Channel Property

Get/set the input channel that is triggered.

Applies To:	Trigger Object

Access:	Read/Write

Syntax:	Dim intVal As Integer
intVal = objTrigger.Channel
objTrigger.Channel = intVal

Remarks

The Channel property determines the input channel that controls the measurement trigger.  The first channel is 1.  The trigger channel is irrelevant if the trigger style is free run.

See Also

Trigger Tab

Playback Trigger Tab (Recording)


Delay Property

Get/set the trigger delay.

Applies To:	Trigger Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTrigger.Delay
objTrigger.Delay = dblVal

Remarks

Determines the setting of the trigger delay, specified in seconds, for the specified input channel.  This applies to both the InpChannel and Recording trigger objects.

See Also

Delay Trigger

Playback Trigger Tab


ExtLevel Property

Get/set the external trigger level.

Applies To:	Trigger Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTrigger.ExtLevel
objTrigger.ExtLevel = dblVal

Remarks

This property lets you retrieve or set the trigger lever for the external trigger.


Holdoff Property

Get/set the trigger hold-off (in Sec).

Applies To:	Trigger Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTrigger.Holdoff
objTrigger.Holdoff = dblVal

Remarks

Determine the length of the trigger holdoff, in seconds.  The holdoff is the length of time that the trigger condition must not be satisfied before accepting a trigger.  For a positive trigger slope, it is the length of time that the input signal amplitude must be less than the trigger level before a Valid trigger can occur.  A larger trigger holdoff makes the trigger less susceptible to a momentary signal glitch.

Trigger behavior is dependent on the hardware being used to acquire your signal.  For details, see Trigger Holdoff.

For more information about triggering, see the topic Triggering Overview.

See Also

Trigger Tab

Playback Trigger Tab


Level Property

Get/set the trigger level for the specified input channel.

Applies To:	Trigger Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTrigger.Level
objTrigger.Level = dblVal

Remarks

Determine the trigger level, in Volts, for the specified input channel.  This applies to both the InpChannel and Recording trigger objects.

The maximum input trigger level is dependant upon the input range (InpChannel.Range) and may be changed when the input range changes.

The Level property is only used if the trigger Style is VsaTrigStyleLevel.

See Also

Level Property

Trigger Level


MagLevel Property

Get/set the magnitude trigger level for the specified input channel.

Applies To:	Trigger Object

Access:	Read/Write

Syntax:	Dim dblVal As Double
dblVal = objTrigger.MagLevel
objTrigger.MagLevel = dblVal

Remarks

Determine the magnitude trigger level, in Volts, for the specified input channel.  This applies to both the InpChannel and Recording trigger objects.  For the InpChannel, this is the magnitude at the IF.

The maximum input trigger level is dependant upon the input range (InpChannel.Range) and may be changed when the input range changes.

The MagLevel property is only used if the trigger Style is VsaTrigStyleMagLevel.

For more information about triggering, see the topic Triggering Overview.

See Also

IF Level

Playback Trigger Tab


Slope Property

Get/set the trigger slope.

Applies To:	Trigger Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaTrigSlope
enumVal = objTrigger.Slope
objTrigger.Slope = enumVal

Remarks

Determine the current trigger slope; either a positive transition from below the trigger level to above it, or a negative transition from above the trigger level to below it.  The trigger slope is not used for the freerun trigger type.

See Also

Trigger Tab


Style Property

Get/set the trigger style.

Applies To:	Trigger Object

Access:	Read/Write

Syntax:	Dim enumVal As VsaTrigStyle
enumVal = objTrigger.Style
objTrigger.Style = enumVal

Remarks


Visual Basic "Hello World"

The program below is provided in the spirit of the "Hello World" programs that every programmer is familiar with.  The idea is to describe a simple application using the objects COM API exposes. This kind of program can be a valuable way to learn how to use a new language or tool, or to acquire confidence that it does things pretty much in the way you would expect from prior experience.

The 89600 VsaVector "Hello World" program, written in Visual Basic, accomplishes the following:

•	Makes a global reference to the application for all procedures.

•	Starts a new program, shows how to get a reference to one that is already running.

•	Makes a variety of settings in preparation for taking a measurement.

•	Takes the measurement.

Note that if you do not have hardware connected, the program will still run using software generated simulated signals.

You can load and run the "Hello World" program from Visual Basic.  The project files are located in the following directory (default install directory):

c:\Program Files\Agilent\89600 VSA\Examples\vb\HelloWorld

NOTE:

The code listed here is typical but may be different from the code provided in the Program Files\Agilent\89600 VSA\Examples directory.

Option Explicit

' "Hello World"

'

' A demonstration program using Agilent 89600 VsaVector software.

'

' To run this you must have a reference to the

' "Agilent 89600 Vector Signal Analyzer 1.0" type library.

' Go to menu Project>References and make sure this is selected.

'

' make a global reference to the 89600 for all procedures

Dim g_oVectorVsa As AgtVsaVector.Application

' form_load() runs once at startup

Private Sub Form_Load()

' get an 89600 object ...

    ' first, here is how to start a new program:

    Set g_oVectorVsa = CreateObject("AgtVsaVector.Application")

    ' ... or, to get a reference to an already running program:

    ' Set g_oVectorVsa = GetObject(,"AgtVsaVector.Application")

    ' make it visible

    g_oVectorVsa.Visible = True

    ' set the title

    g_oVectorVsa.Title = "Hello World"

End Sub

' cmdExit_Click runs when the exit button is clicked

Private Sub cmdExit_Click()

    ' prepare for errors if 89600 not running

    On Error Resume Next

    ' kill 89600

    g_oVectorVsa.Quit

    Set g_oVectorVsa = Nothing

    Unload Me

End Sub

' perform a measurement

Private Sub cmdMeasure_Click()

    ' make a reference to a meas

    Dim Meas As Measurement

    ' get a measurement object

    Set Meas = g_oVectorVsa.Measurement

    ' spin some knobs to see how it's done

    Meas.Average.Style = vsaAvgStyleOff

    Meas.Continuous = False

    Meas.Inputs.InpChannels(1).Range = 0.1122

    Meas.Inputs.Trigger.Style = vsaTrigStyleAuto

    Meas.Frequency.Span = 1000000#

    Meas.Frequency.Zoom = False

    Meas.Frequency.Window = vsaFrqWndUniform

    Meas.Frequency.ResBWArbitrary = True

    ' now start the measurement

    Meas.Start

End Sub


Visual Basic "Hello Worlds"

The following program shows you how to control multiple instances of the 89600 software from Visual Basic.  This program is similar to the Hello World VB program, except it uses multiple instances of the VsaVector application.

You can load and run the "Hello Worlds" program from Visual Basic.  The project files are located in the following directory (default install directory):

c:\Program Files\Agilent\89600 VSA\Examples\vb\HelloWorlds

NOTE:

The code listed here is typical but may be different from the code provided in the Program Files\Agilent\89600 VSA\Examples directory.

Option Explicit

' "Hello Worlds"

'

' A demonstration program using Agilent 89600 VsaVector software.  This

' example controls multiple instances of VsaVector.

'

' To run this you must have a reference to the

' "Agilent 89600 Vector Signal Analyzer 1.0" type library.

' Go to menu Project>References and make sure this is selected.

'

' Before running this program start 2 or more instances of VsaVector.

'

' make a global reference to the 89600 for all procedures

Dim g_oVsaVector As AgtVsaVector.Application

' form_load() runs once at startup

Private Sub Form_Load()

    ' first, find a running VsaVector

    GetVsaRef

End Sub

' get a VsaVector running object reference, and set it's title

Private Function GetVsaRef()

    On Error GoTo Oops

    Set g_oVsaVector = GetObject(, "AgtVsaVector.Application")

    ' make it visible

    g_oVsaVector.Visible = True

    ' set the title

    g_oVsaVector.Title = "Hello Worlds"

    Exit Function

Oops:

    MsgBox "Start an instance of VsaVector!", vbInformation

End Function

' set the title on all other runnings instances of VsaVector

Private Sub SpreadTheWord_Click()

    Dim oAppOther As AgtVsaVector.Application

    Dim i As Integer

    Dim arrHellos As Variant

    Dim arrGoodbyes As Variant

    Dim iWordIdx As Integer

    arrHellos = Array("Grüß Gott", "Bonjour", "Buon Giorno", "¡Hola!")

    arrGoodbyes = Array("Auf Wiedersehen", "Au Revoir", "Arrivederci", "Adios")

    iWordIdx = 0

    With g_oVsaVector

        ' check for 2 or more running VsaVectors

        On Error GoTo Oops1

        If .Count < 2 Then

            MsgBox "Only 1 instance of VsaVector found.  Start more!", vbInformation

            Exit Sub

        End If

        ' set title on other running VsaVector

        On Error GoTo Oops2

        For i = 1 To .Count

            Set oAppOther = .Item(i)

            If Not oAppOther Is Nothing And Not oAppOther Is g_oVsaVector Then

                If Hello.Value = True Then

                    oAppOther.Title = arrHellos(iWordIdx Mod (UBound(arrHellos) + 1)) & "  :-)"

                Else

                    oAppOther.Title = arrGoodbyes(iWordIdx Mod (UBound(arrGoodbyes) + 1)) & "  :-("

                End If

                iWordIdx = iWordIdx + 1

                Set oAppOther = Nothing

            End If

        Next i

        Exit Sub

    End With

Oops1:

    MsgBox "Base VsaVector instance not found.  Will look for another...", vbExclamation

    GetVsaRef

    Exit Sub

Oops2:

    MsgBox "Unable to access VsaVector instance.  Will refresh count...", vbExclamation

    g_oVsaVector.RefreshCount

    Exit Sub

End Sub

' cmdExit_Click runs when the exit button is clicked

Private Sub cmdExit_Click()

    Dim oAppOther As AgtVsaVector.Application

    Dim iCount As Integer

    Dim i As Integer

    On Error GoTo Oops

    With g_oVsaVector

    ' set title on other running VsaVectors

    For i = 1 To .Count

        Set oAppOther = .Item(i)

        If Not oAppOther Is g_oVsaVector Then

            oAppOther.Title = "Happy trails to you..."

            Set oAppOther = Nothing

        End If

    Next i

    End With

Oops:

    Set g_oVsaVector = Nothing

    Unload Me

End Sub


Visual Basic Measurement Demo

The following program is provided as an example to show how to use the COM API to perform a real measurement.  Unlike the "Hello World" program, which really just fires up the application and twiddles some knobs, the "MeasDemo" program below can be used as a template for developing real-world programs.  The MeasDemo program can be broken into the following steps:

1.	Start the VsaVector program or get a reference to an already running VsaVector program.

2.	Set up a measurement.

3.	Start a measurement.

4.	Wait for the measurement to finish.

5.	Transfer measurement data to the example program.

6.	Access the measurement data in the example program.

7.	Exit the VsaVector program.

You can load and run the "MeasDemo" program from Visual Basic.  The project files are located in the following directory (default install directory):

c:\Program Files\Agilent\89600 VSA\Examples\vb\MeasDemo

NOTE:

The code listed here is typical but may be different from the code provided in the Program Files\Agilent\89600 VSA\Examples directory.

Option Explicit

' This is a demonstration of a complete measurement

'

' This routine creates, sets up, starts a measurement, reads

' frequency and voltage data, dumps the data to the debug screen,

' and exits the application.

'

' One would not normally combine all these steps into one routine.

' In particular, the creation of the 89600 app would normally be done

' only once at main form load time and kept around until the VB app

' is done.

Private Declare Sub Sleep Lib "kernel32" (ByVal dwMilliseconds As Long)

Public Sub MeasDemo()

    Dim oApp As AgtVsaVector.Application

    Dim oMeas As AgtVsaVector.Measurement

    Dim oDisp As AgtVsaVector.Display

    Dim vTime As Variant

    Dim vArrX As Variant    ' Will be filled with an array of doubles

    Dim vArrY As Variant    ' Will be filled with an array of doubles

    Dim bMeasDone As Boolean

    Dim bCreated As Boolean

    Dim i As Long

    ' First, try getting a reference to an already running 89600 VSA

    bCreated = False

    On Error Resume Next

    Set oApp = GetObject(, "AgtVsaVector.Application")

    If oApp Is Nothing Then

        ' There is no running 89600 VSA, try to create a new one

        Set oApp = CreateObject("AgtVsaVector.Application")

        bCreated = True

    End If

    On Error GoTo 0

    If oApp Is Nothing Then

        MsgBox "Unable to create 89600 VSA object", vbCritical

        Exit Sub

    End If

    ' Make it visible

    oApp.Visible = True

    ' Label the analyzer display

    oApp.Title = "Measurement Demo"

    ' Get interfaces to major items

    Set oMeas = oApp.Measurement

    Set oDisp = oApp.Display

    ' Set to defaults

    oDisp.Default

    oMeas.Default

    oMeas.Reset

    ' Set center and span frequencies

    oMeas.Frequency.Center = 5000000#   ' 5 MHz center

    oMeas.Frequency.Span = 1000000#     ' 1 MHz span

    ' Set input range

    oMeas.Inputs.InpChannels(1).Range = 1#

    ' By default, trace A (index 1) shows a spectrum.

    ' Set the trace to display linear volts so the upcoming

    '   read will return volts.

    oDisp.Traces(1).Format = vsaTrcFmtLinMag

    ' Set for single measurement

    oMeas.Continuous = False

    ' Start measurement

    oMeas.Start

    ' Wait for meas done, but don't bother it too often

    vTime = Now

    Do

        Sleep 100

        DoEvents

        bMeasDone = oMeas.Status.Value And vsaStatusBitMeasDone

    Loop Until bMeasDone Or DateDiff("s", vTime, Now) > 5  ' bail after 5 seconds

    ' Check to see if meas was stuck

    If Not bMeasDone Then

        MsgBox "Measurement failed to complete", vbCritical

        Exit Sub

    End If

    ' Pretty up the displays

    oDisp.Traces(1).YScaleAuto

    oDisp.Traces(2).YScaleAuto

    ' Get y-axis data (voltages)

    vArrY = oDisp.Traces(1).Data(vbDouble, vsaTrcDataY, False)

    ' Get x-axis data (frequencies)

    vArrX = oDisp.Traces(1).Data(vbDouble, vsaTrcDataX, False)

    ' Dump frequencies and voltages to debug screen

    For i = LBound(vArrY) To UBound(vArrY)

        Debug.Print vArrX(i), vArrY(i)

    Next i

    ' Shut down oApp if I started it

    If bCreated Then oApp.Quit

End Sub

Private Sub cmdMeasDemo_Click()

    MeasDemo

End Sub


C Measurement Demo

The following program is provided as an example to show how to use the COM API to perform a real measurement. The import statement in the program (#import "..\..\..\Vector\VsaVector.exe") assumes a certain location for the VsaVector.exe type library.  If you copy this code, make sure the import statement points to the correct location of the VsaVector.exe type library.

This program is identical in function to the Visual Basic Measurement Demo program and can be broken into the same steps, as follows:

1.	Start the VsaVector program or get a reference to an already running VsaVector program.

2.	Set up a measurement.

3.	Start a measurement.

4.	Wait for the measurement to finish.

5.	Transfer measurement data to the example program.

6.	Access the measurement data in the example program.

7.	Exit the VsaVector program.

Tip

Files for all example programs are located in c:\Program Files\Agilent\89600 VSA\Examples.

// MeasDemo.cpp : Example program to read data from the Agilent 89600 VSA

//

#include "stdafx.h"

#include <atlbase.h>

#include <comdef.h>

#include <stdarg.h>

#include <stdio.h>

#import "..\..\..\Vector\VsaVector.exe"

using namespace AgtVsaVector;

// Pointers to Agilent 89600 COM interfaces

_ApplicationPtr oApp;

_MeasurementPtr oMeas;

_DisplayPtr oDisp;

//  Generate error message and exit program

void error (char *fmt, ...)

{

    va_list args;

    va_start (args, fmt);

    vfprintf (stderr, fmt, args);

    fprintf (stderr, "\n");

    va_end (args);

CoUninitialize();

    exit (-1);

}

// Returns true if the array is passed by reference

bool MyArrayIsByRef (const VARIANT &vVal)

{

return ( (vVal.vt & (VT_ARRAY + VT_BYREF) ) == VT_ARRAY + VT_BYREF);

}

// Returns the pointer to the safe array.  Returns NULL if not an array

SAFEARRAY *MyArrayPsa (const VARIANT &vVal)

{

if ( (vVal.vt & VT_ARRAY) != VT_ARRAY)

        return NULL;

    if (MyArrayIsByRef(vVal) )

        return *vVal.pparray;

    else

        return vVal.parray;

}

// Returns the number of elements in the passed array.  Returns 0 if

//   the parameter is not an array or is not a one-dimensional array.

long MyArraySize (const VARIANT &vVal)

{

    long iLow, iHigh;

SAFEARRAY *pArray = MyArrayPsa (vVal);

if (pArray == NULL || SafeArrayGetDim (pArray) != 1)

return 0;

SafeArrayGetLBound (pArray, 1, &iLow);

SafeArrayGetUBound (pArray, 1, &iHigh);

    return iHigh+1 - iLow;

}

// Locks the passed array and returns a pointer to the first element.

//    Returns NULL if the parameter is not an array.

void *MyArrayLockPtr (const VARIANT &vVal)

{

void* p = NULL;

if (FAILED (SafeArrayAccessData (MyArrayPsa(vVal), (void**) &p) ) )

return NULL;

    return p;

}

// Unlocks the passed array

void MyArrayUnlock(const VARIANT FAR& vVal)

{

SafeArrayUnaccessData (MyArrayPsa (vVal));

}

int main(int argc, char* argv[])

{

HRESULT hr;

bool bCreated = false;

// Initialize COM

CoInitialize (NULL);

// Get an existing 89600 VSA instance.

hr = oApp.GetActiveObject(__uuidof(Application));

if (hr != S_OK) {

// None there - create one.

bCreated = true;

hr = oApp.CreateInstance(__uuidof(Application));

if (hr != S_OK)

error ("CreateInstance error.");

}

    oApp->Title = "Measurement Demo";  // label the analyzer display

oApp->Visible = VARIANT_TRUE;      // Make application visible.

// Get interfaces to major items

oMeas = oApp->Measurement;

oDisp = oApp->Display;

    // Set to defaults

    oDisp->Default();

    oMeas->Default();

    oMeas->Reset();

    // Set center and span frequencies

    oMeas->Frequency->Center = 5e6;	// 5 MHz center

    oMeas->Frequency->Span = 1e6;	// 1 MHz span

    // Set input range

    oMeas->Inputs->InpChannels->Item[1]->Range = 1.0;	// 1 Volt peak

    // The default trace 1 shows a spectrum.

    // Set trace 1 to display volts so the upcoming read will return volts.

    oDisp->Traces->Item[1]->Format = vsaTrcFmtLinMag;

    // Set for single measurement

    oMeas->Continuous = VARIANT_FALSE;

    // Start measurement

    oMeas->Start();

    // Wait for measdone, but don't bother it too often

    double dTimeOut = 5.0;	// 5 second timeout

bool bMeasDone = false;

    while ( ! bMeasDone && dTimeOut >= 0.0) {

        Sleep (100);	// sleep for 100 mS

dTimeOut -= 0.1;

        bMeasDone = (oMeas->Status->Value & vsaStatusBitMeasDone) != 0;

    }

    // Check if meas was stuck

    if ( ! bMeasDone)

        error ("Measurement failed to complete");

    // Pretty up the displays

    oDisp->Traces->Item[1]->YScaleAuto();

    oDisp->Traces->Item[2]->YScaleAuto();

    // get amplitude data

    _variant_t vArrY = oDisp->Traces->Item[1]->Data[VT_R8][vsaTrcDataY][VARIANT_FALSE];

    // get data x axis (frequencies)

    _variant_t vArrX = oDisp->Traces->Item[1]->Data[VT_R8][vsaTrcDataX][VARIANT_FALSE];

    // dump frequencies and voltages

long nCnt = MyArraySize (vArrY);

if (nCnt <= 0)

printf ("No Data on Trace\n");

else {

double *pY = (double*) MyArrayLockPtr (vArrY);

double *pX = (double*) MyArrayLockPtr (vArrX);

printf ("Trace Data (X, Y)\n");

while (--nCnt >= 0)

printf ("%g, %g\n", *pX++, *pY++);

MyArrayUnlock (vArrY);

MyArrayUnlock (vArrX);

}

// Clean Up

oMeas = NULL;

oDisp = NULL;

if (bCreated)

oApp->Quit();	// Exit 89600 VSA if I started it

oApp = NULL;

CoUninitialize();

return 0;

}


Excel Measurement Demo

The following program is provided as an example to show how to use the COM API to perform a real measurement from within MS Excel. The program is implemented as VBA script.  An easy way to see it in action is to open a new spreadsheet in MS Excel, and put a single button in it, called demoRead.  Set the button properties to using Excel for the user interface.

This program is identical in function to the Visual Basic Measurement Demo program and can be broken into the same steps, as follows:

1.	Start the VsaVector program or get a reference to an already running VsaVector program.

2.	Set up a measurement.

3.	Start a measurement.

4.	Wait for the measurement to finish.

5.	Transfer measurement data to the example program.

6.	Access the measurement data in the example program.

7.	Exit the VsaVector program.

Tip

Files for all example programs are located in c:\Program Files\Agilent\89600 VSA\Examples.

Option Explicit

' This is a demonstration of a complete measurement

'

' This routine creates, sets up, starts a measurement, reads

' frequency and voltage data, dumps the data to the debug screen,

' and exits the application.

'

' One would not normally combine all these steps into one routine.

' In particular, the creation of the 89600 app would normally be done

' only once at main form load time and kept around until the VB app

' is done.

Private Declare Sub Sleep Lib "kernel32" (ByVal dwMilliseconds As Long)

Public Sub MeasDemo()

    Dim oApp As AgtVsaVector.Application

    Dim oMeas As AgtVsaVector.Measurement

    Dim oDisp As AgtVsaVector.Display

    Dim vTime As Variant

    Dim vArrX As Variant    ' Will be filled with an array of doubles

    Dim vArrY As Variant    ' Will be filled with an array of doubles

    Dim bMeasDone As Boolean

    Dim bCreated As Boolean

    Dim i As Long, iRow As Long

    ' First, try getting a reference to an already running 89600 VSA

    bCreated = False

    On Error Resume Next

    Set oApp = GetObject(, "AgtVsaVector.Application")

    If oApp Is Nothing Then

        ' There is no running 89600 VSA, try to create a new one

        Set oApp = CreateObject("AgtVsaVector.Application")

        bCreated = True

    End If

    On Error GoTo 0

    If oApp Is Nothing Then

        MsgBox "Unable to create 89600 VSA object", vbCritical

        Exit Sub

    End If

    ' Make it visable

    oApp.Visible = True

    ' Label the analyzer display

    oApp.Title = "Measurement Demo"

    ' Get interfaces to major items

    Set oMeas = oApp.Measurement

    Set oDisp = oApp.Display

    ' Set to defaults

    oDisp.Default

    oMeas.Default

    oMeas.Reset

    ' Set center and span frequencies

    oMeas.Frequency.Center = 5000000#   ' 5 MHz center

    oMeas.Frequency.Span = 1000000#     ' 1 MHz span

    ' Set input range

    oMeas.Inputs.InpChannels(1).Range = 1#

    ' By default, trace A (index 1) shows a spectrum.

    ' Set the trace to display linear volts so the upcoming

    '   read will return volts.

    oDisp.Traces(1).Format = vsaTrcFmtLinMag

    ' Set for single measurement

    oMeas.Continuous = False

    ' Start measurement

    oMeas.Start

    ' Wait for meas done, but don't bother it too often

    vTime = Now

    Do

        Sleep 100

        DoEvents

        bMeasDone = oMeas.Status.Value And vsaStatusBitMeasDone

    Loop Until bMeasDone Or DateDiff("s", vTime, Now) > 5  ' bail after 5 seconds

    ' Check to see if meas was stuck

    If Not bMeasDone Then

        MsgBox "Measurement failed to complete", vbCritical

        Exit Sub

    End If

    ' Pretty up the displays

    oDisp.Traces(1).YScaleAuto

    oDisp.Traces(2).YScaleAuto

    ' Get y-axis data (voltages)

    vArrY = oDisp.Traces(1).Data(vbDouble, vsaTrcDataY, False)

    ' Get x-axis data (frequencies)

    vArrX = oDisp.Traces(1).Data(vbDouble, vsaTrcDataX, False)

    ' Dump frequencies and voltages to first 2 columns of spreadsheet

    iRow = 1

    Columns("A:B").ClearContents

    For i = LBound(vArrY) To UBound(vArrY)

        'Debug.Print vArrX(i), vArrY(i)

        Range("A" & iRow).Value = vArrX(i)

        Range("B" & iRow).Value = vArrY(i)

        iRow = iRow + 1

    Next i

    ' Shut down oApp if I started it

    If bCreated Then oApp.Quit

End Sub


MATLAB Measurement Demo

This program shows how you can run the 89600 analyzer from a MATLAB program. It is identical in function to the Visual Basic Measurement Demo program and can be broken into the same steps, as follows:

1.	Start the VsaVector program or get a reference to an already running VsaVector program.

2.	Set up a measurement.

3.	Start a measurement.

4.	Wait for the measurement to finish.

5.	Transfer measurement data to the example program.

6.	Access the measurement data in the example program.

7.	Exit the VsaVector program.

Tip

Files for all example programs are located in c:\Program Files\Agilent\89600 VSA\Examples.

%DEMOREAD Demonstrates a complete measurement using the

%    Agilent Technologies 89600 Vector Signal Analyzer Application.

%

%    This routine creates, sets up, starts a measurement, reads

%    frequency and voltage data, plots the data, and quits the application.

%

%    Normally all these steps would be combined into one routine.

%    In particular, the creation of the 89600 app would normally be done

%    only once and kept around until the application is done.

%

%    Type 'demoread' to see it run.

clear all;

% Create a new 89600 object

% Note: Beware since this creates a new instance of the application

%       which may interfere with existing instances when real hardware

%       is used.

hApp = actxserver('AgtVsaVector.Application');

% make it visible

set(hApp,'Visible',-1);

% label the analyzer display

set(hApp,'Title','Demo Data Read');

% get interfaces to major items

hMeas = get(hApp,'Measurement');

hDisp = get(hApp,'Display');

%set to defaults

invoke(hDisp,'Default');

invoke(hMeas,'Default');

invoke(hMeas,'Reset');

% set center and span frequencies

% (how about 1 volt at 5 meg with 1 meg span for demo)

hFreq = get(hMeas,'Frequency');

set(hFreq,'Center',5000000);

set(hFreq,'Span',1000000);

% set input range

hInputs = get(hMeas,'Inputs');

hInputChans = get(hInputs,'InpChannels');

hInputChan = get(hInputChans,'Item',1);

set(hInputChan,'Range',1);

% The default trace 1 shows a spectrum.

% Set trace 1 to display volts so the upcoming read will return volts.

hTraces = get(hDisp,'Traces');

hTrace1 = get(hTraces,'Item',1);

enumVsaTrcFormat = 1;	% vsaTrcFmtLinMag = 1

set(hTrace1,'Format',enumVsaTrcFormat);

% set for single measurement

set(hMeas,'Continuous',0);	% False = 0

% start measurement

invoke(hMeas,'Start');

% wait for measdone, but don't bother it too often

% Set timeout to 5 seconds

enumVsaStatusBits = 1;	% vsaStatusBitMeasDone = 1

bMeasDone = 0;

t0=clock;

while(bMeasDone==0 & etime(clock,t0)<=5)

   pause(.1);

   hStatus = get(hMeas,'Status');

   Value = get(hStatus,'Value');

   bMeasDone = bitand(Value, enumVsaStatusBits);

   release(hStatus);

end

% check if meas was stuck

if bMeasDone == 0

error('Measurement failed to complete');

end

% pretty up the displays

hTrace2 = get(hTraces,'Item',2);

invoke(hTrace1,'YScaleAuto');

invoke(hTrace2,'YScaleAuto');

% get amplitude data

enumVbVarType = 5;	% vbDouble = 5

enumVsaTrcDataSelect = 2;	% vsaTrcDataY = 2

vArrY = get(hTrace1,'Data',enumVbVarType,enumVsaTrcDataSelect,0);

% get phase data x axis (frequencies)

enumVsaTrcDataSelect = 1;	% vsaTrcDataX = 1

vArrX = get(hTrace1,'Data',enumVbVarType,enumVsaTrcDataSelect,0);

% dump frequencies and voltages to debug screen

%[vArrX' vArrY']

% plot frequencies and voltages

plot(vArrX,vArrY);

invoke(hApp,'Quit');	% Comment this line out to leave the application running.

% Release objects

release(hTrace1);

release(hTrace2);

release(hTraces);

release(hInputChan);

release(hInputChans);

release(hInputs);

release(hFreq);

release(hDisp);

release(hMeas);

% Delete App

delete(hApp);


VEE Measurement Demo

The following VEE program is provided as an example to show how to use the COM API to perform a real measurement. This program is identical in function to the Visual Basic Measurement Demo program and can be broken into the same steps, as follows:

1.	Start the VsaVector program.

2.	Set up a measurement.

3.	Start a measurement.

4.	Wait for the measurement to finish.

5.	Transfer measurement data to the example program.

6.	Access the measurement data in the example program.

7.	Exit the VsaVector program.

Tip

Files for all example programs are located in c:\Program Files\Agilent\89600 VSA\Examples.


VEE Program using the E4406 Vector Signal Analyzer

Included with the 89600 VSA software is an example VEE program, "E4406AlternateDemo.vee", that shows you how to programmatically alternate between controlling an E4406 Vector Signal Analyzer via the 89600 software and controlling it directly via SCPI commands over GP-IB (bypassing the 89600 software).

The program uses the Disconnect method to disconnect the 89600 software from the hardware so that another program can use the E4406 Vector Signal Analyzer.

Tip

Files for all example programs are located in c:\Program Files\Agilent\89600 VSA\Examples.


VsaVector / VsaScalar Object Model

The following illustration shows all objects for the VsaVector and VsaScalar applications.  To see the complete object model (including properties, methods, and events), click the following link:

 Click Here for Expanded Object Model Diagram


Application Object Model

See Also

Key


AnalogDemod Object Model

See Also

Key


ArbSources Object Model

See Also

Key


Average Object Model

See Also

Key


Calibration Object Model

See Also

Key


DataRegs Object Model

See Also

Key


DigDemod Object Model

See Also

Key


DigDemod3G Object Model

See Also

Key


DigDemodOFDM Object Model

See Also

Key


Display Object Model

See Also

Key


Frequency Object Model

See Also

Key


Hardware Object Model

See Also

Key


InpChannels Collection
InpChannels Object Model

See Also

Key


Inputs Object Model

See Also

Key


License Object Model

See Also

Key


Macros Collection
Macros Object Model

See Also

Key


Marker Object Model

See Also

Key


MathFuncs Collection
MathFuncs Object Model

See Also

Key


Measurement Object Model

See Also

Key


Recording Object Model

See Also

Key


Source Object Model

See Also

Key


Spectrogram Object Model

See Also

Key


Status Object Model

See Also

Key


Time Object Model

See Also

Key


Trace Object Model

See Also

Key


Traces Collection
Traces Object Model

See Also

Key


Trigger Object Model

See Also

Key


OM See Also
VsaVector / VsaScalar Object Model


Apps OM See Also
VsaVector / VsaScalar Object Model

Application Object Model


Apps Display OM See Also
VsaVector / VsaScalar Object Model

Application Object Model

Display Object Model


Apps Display Traces OM See Also
VsaVector / VsaScalar Object Model

Application Object Model

Display Object Model

Traces Collection


Apps Measurement OM See Also
VsaVector / VsaScalar Object Model

Application Object Model

Measurement Object Model


Apps Measurement Inputs OM See Also
VsaVector / VsaScalar Object Model

Application Object Model

Measurement Object Model

Inputs Object Model


How To Use This Help File

To do this...	Click...
Display or hide the navigation pane (Contents, Index, and Search tabs)...
Display the documentation roadmap...
Browse through the online topics...
View the Table of Contents…
Display the online help index...
Search for a word...
Display a history of topics that you’ve visited…
To print a single topic...
To print an entire Book…	(in the Table of Contents)
To change the displayed font size…


Acknowledgements

The following products are mentioned in one or more places in the Agilent 89600-series documentation.

Product	Acknowledgement
Adobe® and Acrobat®	These products are trademarks of Adobe Systems Incorporated.
Microsoft®, Windows NT®, Windows®, and MS Windows®	These products are U.S. registered trademarks of Microsoft Corporation.
MS Excel, MS Word, MS Office, VBScript	These products are products of Microsoft Corporation.
MATLAB	MATLAB is a product of The MathWorks, Inc.


The Documentation Roadmap is not installed on your system.


1999-2002, Agilent Technologies


This documentation is not installed on your system.


This document was not available for inclusion in the online help. You can download the PDF from the 89600 [image] Web page .


This document was not available for inclusion in the online help. You can download the PDF from the 89600 [image] Web page .


This document was not available for inclusion in the online help. You can download the PDF from the 89600 [image] Web page .